iso999
Audit indexes and index-producing software for adherence to ISO 999:1996 (content, organization and presentation of indexes). USE FOR: reviewing a back-of-book index or book index; code that generates indexes (collation/filing, locators and page ranges, see/see also resolution, subheading nesting; makeindex/xindy styles, Sphinx genindex, Docusaurus/MkDocs index plugins, custom indexers); linting a generated index (text, Markdown, LaTeX .ind, HTML); reviewing index entries and markup in doc sources (\index{}, .. index::, DITA indexterm). DO NOT USE FOR: general source-code quality, search-engine/database indexes, keyword extraction, tables of contents, or choosing what subjects to index (ISO 5963).
- License 许可
- MIT
- 最近更新
- 2026-10-25
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- iso999
- metadata
- { "author": "Alex Harmon", "edition": "tool-only", "version": "1.1.0-tools", "standard": "ISO 999:1996(E), second edition (not included)" }
- description
- Audit indexes and index-producing software for adherence to ISO 999:1996 (content, organization and presentation of indexes). USE FOR: reviewing a back-of-book index or book index; code that generates indexes (collation/filing, locators and page ranges, see/see also resolution, subheading nesting; makeindex/xindy styles, Sphinx genindex, Docusaurus/MkDocs index plugins, custom indexers); linting a generated index (text, Markdown, LaTeX .ind, HTML); reviewing index entries and markup in doc sources (\index{}, .. index::, DITA indexterm). DO NOT USE FOR: general source-code quality, search-engine/database indexes, keyword extraction, tables of contents, or choosing what subjects to index (ISO 5963).
02 资源文件 44
- 其他.gitignore66 B
- 脚本evals/baselines/api-audits/go/analyze.py3.5 KB
- 脚本evals/baselines/api-audits/go/convert_examples.py731 B
- 脚本evals/baselines/api-audits/go/convert.py5.1 KB
- 参考文档evals/baselines/api-audits/go/go_ast.html334.3 KB
- 参考文档evals/baselines/api-audits/go/math_big.html273.8 KB
- 参考文档evals/baselines/api-audits/go/math_bits.html154.8 KB
- 参考文档evals/baselines/api-audits/go/net_http.html452.7 KB
- 参考文档evals/baselines/api-audits/go/probe.html64.3 KB
- 参考文档evals/baselines/api-audits/go/reflect.html258.0 KB
- 参考文档evals/baselines/api-audits/go/REPORT.md9.1 KB
- 参考文档evals/baselines/api-audits/go/std.html287.6 KB
- 参考文档evals/baselines/api-audits/go/strings.html227.1 KB
- 参考文档evals/baselines/api-audits/go/sync_atomic.html160.0 KB
- 参考文档evals/baselines/api-audits/go/time.html263.6 KB
- 参考文档evals/baselines/api-audits/rust/chrono-all.html7.0 KB
- 脚本evals/baselines/api-audits/rust/displaced.py1.2 KB
- 参考文档evals/baselines/api-audits/rust/jiff-all.html10.0 KB
- 参考文档evals/baselines/api-audits/rust/REPORT.md8.3 KB
- 脚本evals/baselines/api-audits/rust/rustdoc2idx.py4.2 KB
- 参考文档evals/baselines/api-audits/rust/std-all.html140.6 KB
- 参考文档evals/baselines/api-audits/rust/time-all.html15.6 KB
- 参考文档evals/baselines/api-audits/rust/tricky-all.html6.9 KB
- 脚本evals/baselines/api-audits/rust/tricky-src/src/lib.rs2.6 KB
- 参考文档evals/baselines/api-audits/servicenow/explain_list_raw.txt35.2 KB
- 脚本evals/baselines/api-audits/servicenow/explain_list.js976 B
- 参考文档evals/baselines/api-audits/servicenow/REPORT.md7.6 KB
- 脚本evals/baselines/api-audits/servicenow/to_lint.py951 B
- 参考文档evals/baselines/api-audits/SUMMARY.md5.2 KB
- 参考文档evals/golden/darwin-2009-index.html100.9 KB
- 参考文档evals/golden/darwin-2009-index.txt41.7 KB
- 参考文档evals/golden/golden.json9.3 KB
- 参考文档evals/golden/sphinx/genindex.html13.1 KB
- 参考文档evals/golden/sphinx/src/api.rst918 B
- 脚本evals/golden/sphinx/src/conf.py332 B
- 参考文档evals/golden/sphinx/src/guide.rst467 B
- 参考文档evals/golden/sphinx/src/index.rst798 B
- 其他evals/golden/xindy-hyperref.ind2.0 KB
- 参考文档README.md10.0 KB
- 参考文档references/tooling.md13.4 KB
- 脚本scripts/iso999_lint.py222.2 KB
- 脚本scripts/iso999_markup.py64.4 KB
- 脚本scripts/test_iso999_lint.py93.3 KB
- 脚本scripts/test_iso999_markup.py29.3 KB
03 SKILL.md 正文
ISO 999 index audit tools (tool-only edition)
The clause-by-clause guidance for ISO 999:1996 is not included because the standard is licensed; use your own licensed copy to interpret findings.
This edition contains the two linters, their tests, and a golden corpus. Each finding carries a rule ID and a clause number. The tools do not tell you what the clause requires. Read that clause in your licensed copy before you report the finding. Do not paste text of the standard into reports, issues or commits: cite clause numbers.
What the tools check
Both tools are standard-library Python 3 (3.9+) and heuristic: every finding is a prompt for review, to be confirmed against the index or the source before it goes in a report.
| Tool | Input | Scope |
|---|---|---|
scripts/iso999_lint.py |
A finished index: plain text, Markdown, LaTeX .ind (makeindex, xindy, hyperref), HTML lists, paragraphs or tables, generated API listings |
Filing order, subheading order, locators and ranges, cross-references, special-matter markers, layout of text indexes |
scripts/iso999_markup.py |
Index markup in doc sources: LaTeX \index{}, makeindex .idx, Sphinx .. index:: and :index:, DITA <indexterm>, or a custom inline syntax |
Variant headings, inversion, sort-as keys, cross-reference integrity, unclosed ranges |
references/tooling.md documents every flag, the input parser, and the
known limits.
Rule IDs and clauses
The clause number is part of each rule ID. --list-rules prints the same
table with a one-line description of what the tool detects.
| Rule ID | Tool | Clause | Severity |
|---|---|---|---|
ISO999-7.1.3-NOTE |
lint | §7.1.3; 9.2 | info |
ISO999-8.1-DUPLICATE |
lint | §8.1 | warn |
ISO999-8.1-CASEBLOCK |
lint | §8.1 | warn |
ISO999-8.2-MODE |
lint | §8.2 | info |
ISO999-8.2-MIXED |
lint | §8.2 | warn |
ISO999-8.2-ORDER |
lint | §8.2 | warn |
ISO999-8.3-ORDER |
lint | §8.3 | warn |
ISO999-8.5-ORDER |
lint | §8.5 | warn |
ISO999-8.7-SORTKEY |
lint | §8.7 | warn |
ISO999-8.6-ORDER |
lint | §8.6 | warn |
ISO999-8.6-SYSTEMATIC |
lint | §8.6 | info |
ISO999-8.6-PAGEORDER |
lint | §8.6 | warn |
ISO999-7.2.3.5-MAXLOC |
lint | §7.2.3.5; 7.4.3 | warn |
ISO999-7.4.3-ASCENDING |
lint | §7.4.3 | info |
ISO999-7.4.3-DUPLICATE |
lint | §7.4.3 | warn |
ISO999-7.4.3-OVERLAP |
lint | §7.4.3.1 | warn |
ISO999-7.4.3.1-REVERSED |
lint | §7.4.3.1 | warn |
ISO999-7.4.3.1-DASH |
lint | §7.4.3.1 | warn |
ISO999-7.4.3.1-ELISION |
lint | §7.4.3.1 | warn |
ISO999-7.4.3.1-TEENS |
lint | §7.4.3.1 | info |
ISO999-7.4.3.1-OPEN |
lint | §7.4.3.1 | warn |
ISO999-7.4.3.2-PASSIM |
lint | §7.4.3.2 | warn |
ISO999-7.4.5-SEPARATOR |
lint | §7.4.5 | warn |
ISO999-7.2.2.2-NUMBER |
lint | §7.2.2.2 | info |
ISO999-7.3.1.1-VARIANT |
lint | §7.3.1.1 | info |
ISO999-7.5-SEPARATOR |
lint | §7.5.1; 7.5.2.1 | warn |
ISO999-7.5.1-DANGLING |
lint | §7.5.1 | warn |
ISO999-7.5.2-DANGLING |
lint | §7.5.2 | warn |
ISO999-7.5.1-LOCATORS |
lint | §7.5.1 | warn |
ISO999-7.5.1-CHAIN |
lint | §7.5.1 | warn |
ISO999-7.5.1-CYCLE |
lint | §7.5.1 | warn |
ISO999-7.5.1-FEW |
lint | §7.5.1 | info |
ISO999-7.5-SELF |
lint | §7.5 | warn |
ISO999-7.5-TARGETORDER |
lint | §7.5.1; 7.5.2.1 | warn |
ISO999-7.5.2.1-PLACEMENT |
lint | §7.5.2.1 | warn |
ISO999-7.5.2.1-SAMELOC |
lint | §7.5.2.1 | warn |
ISO999-7.5.2.1-NOREFS |
lint | §7.5.2.1 | info |
ISO999-8.1-CASE-ORDER |
lint | §8.1 | warn |
ISO999-3.10-HOMOGRAPH |
lint | §3.10 | info |
ISO999-8-DISPLACED |
lint | §8 | info |
ISO999-8.6-RUNS |
lint | §8.6 | warn |
ISO999-7.4-ANCHOR |
lint | §7.4 | warn |
ISO999-8.1-LOCALE |
lint | §8.1; 8.4 | info |
ISO999-8-ROOTCAUSE |
lint | §8.1; 8.4 | warn |
ISO999-7.3.4.2-ARTICLE |
lint | §7.3.4.2 | warn |
ISO999-7.3.6-ABBREV |
lint | §7.3.6 | warn |
ISO999-7.3.6-VARIANT |
lint | §7.3.6 | info |
ISO999-7.3.1-HONORIFIC |
lint | §7.3.1 | info |
ISO999-7.4.2-LOCSEP |
lint | §7.4.2.2.1 | warn |
ISO999-7.4.2-SEQUENCE |
lint | §7.4.2.2.1 | warn |
ISO999-7.4.2-PREFIX |
lint | §7.4.2.2.1 | warn |
ISO999-7.4.2-SEQORDER |
lint | §7.4.2.2.1; 7.4.3 | info |
ISO999-7.4.4-SPECIAL |
lint | §7.4.4 | info |
ISO999-9.1.2.4-INDENT |
lint | §9.1.2.4 | warn |
ISO999-9.4.1.4-TURNOVER |
lint | §9.1.2.4; 9.4.1.4 | warn |
ISO999-9.5-RUNON |
lint | §9.5; 7.2.3.3 | warn |
ISO999-PARSE-HEALTH |
lint | §tool | info |
ISO999-7.2.2.2-NUMBER |
markup | §7.2.2.2 | warn |
ISO999-7.3.1.1-VARIANT |
markup | §7.3.1.1 | warn |
ISO999-6.3-INVERSION |
markup | §6.3; 7.2.2.4 | warn |
ISO999-6.3-CASE |
markup | §6.3 | warn |
ISO999-8.1-SORTAS |
markup | §8.1 | warn |
ISO999-8.3-SORTAS |
markup | §8.3 | info |
ISO999-7.5.1-DANGLING |
markup | §7.5.1; 3.13 | warn |
ISO999-7.5.2-DANGLING |
markup | §7.5.2 | warn |
ISO999-7.5.1-CHAIN |
markup | §7.5.1; 3.13 | warn |
ISO999-7.5.1-CYCLE |
markup | §7.5.1 | warn |
ISO999-3.13-LOCATORS |
markup | §3.13; 7.5.1 | warn |
ISO999-7.5-SELF |
markup | §7.5 | warn |
ISO999-7.4.3.1-UNCLOSED |
markup | §7.4.3.1 | warn |
ISO999-7.4.3.1-STRAY |
markup | §7.4.3.1 | warn |
MARKUP-PARSE |
markup | §- | info |
warn means probably inconsistent or likely to mislead a reader. info
means worth a look. Neither is a verdict of conformance: you assign the
report severity after you read the clause.
How to run the tools
Set S to this skill's scripts folder, for example
S=~/.claude/skills/iso999/scripts.
Generated index output:
python3 $S/iso999_lint.py index.txt --filing word # match the declared filing method
python3 $S/iso999_lint.py index.txt --dump-tree # if ISO999-PARSE-HEALTH fires, fix flags first
python3 $S/iso999_lint.py index.html --json # machine-readable output
python3 $S/iso999_lint.py --list-rules # rule ID, clause, severity
Index markup in doc sources:
python3 $S/iso999_markup.py docs/ --format auto # latex | idx | rst | dita
python3 $S/iso999_markup.py docs/ --format custom \
--entry-regex '\{\{\s*(?P<kind>index|see|seealso)\s*:\s*(?P<body>.*?)\s*\}\}'
python3 $S/iso999_markup.py docs/ --entries # list every extracted entry
Exit status for both tools: 0 no warnings, 1 warnings, 2 usage, read or parse error. Files that are not available locally (for example evicted cloud-synced files) are skipped and counted.
Workflow:
- Identify the targets (code, output, markup), the index language and locale, and any declared conventions (introductory note, style guide).
- If the index is generated, rebuild it from source and lint the rebuilt copy. If only code is in scope, build a sample index with it and lint that.
- Check parse health first.
ISO999-8-ROOTCAUSEis one finding, not many. - Confirm each finding against the index, then read the cited clause in your licensed copy and decide the report severity.
Report format
# ISO 999:1996 adherence — <target>
Scope: <targets audited>, locale <xx>, declared conventions: <list or "none found">
Summary: N nonconformities, N deviations, N advisories, N review notes
Evidence: <tool runs with counts, e.g. "iso999_lint --filing word: 412 entries, 9 warn, 2 info">
## Findings
| # | Severity | Check ID | Ref | Target | Location | Finding | Evidence | Fix |
|---|---|---|---|---|---|---|---|---|
## Review notes
## Not run / not applicable
## Assumptions
## Reproduction
- Severity is one of these words: Nonconformity, Deviation,
Advisory or Review note. Choose it from the strength of the
clause in your licensed copy; the tool's
warn/infois only a hint. - Check ID is the rule ID (for example
ISO999-8.2-ORDER). Ref is the clause (§x.y). Target iscode,outputormarkup. - Location is a file:line or an index heading. Evidence gives the tool output or the entries concerned.
- One root cause is one finding: list the other rule IDs in the same row.
- Rank findings by severity, then by entries affected.
- Do not report a clean result for checks you did not run.
Worked examples
evals/baselines/api-audits/ holds audits of the Go, Rust and ServiceNow
documentation indexes in this format, with the converters and inputs used.
evals/golden/ pins the linter's finding counts on public indexes; see
references/tooling.md.
04 同仓库更多 Skills
wcag22-a11y
暂无简介
wcag22-a11y
Audit web content for WCAG 2.2 conformance (also WCAG 2.1/2.0 Level A/AA) with tool-assisted and manual checks. USE FOR: accessibility (a11y) audits and reviews of web pages, sites, HTML, components (React/JSX/TSX, Vue, Svelte, server templates) and CSS; colour contrast; keyboard access, focus order, focus visible, focus not obscured; target size; screen reader issues in markup (names, roles and states, ARIA); forms, labels and error messages; reflow, zoom and text spacing; accessible authentication, consistent help, redundant entry, dragging; status messages; VPAT/ACR evidence and Section 508 / EN 301 549 mapping at the WCAG level. DO NOT USE FOR: native mobile app platform guidelines beyond WCAG applicability, legal advice, PDF remediation (unless the content is HTML), SEO, performance or security audits, ISO 999 indexes, RFC 3339 timestamps, ASD-STE100 writing.
ste100
Write, rewrite, audit, or answer questions about ASD-STE100 Simplified Technical English (STE, STE100), the controlled language for technical documentation. USE FOR: drafting or rewriting READMEs, guides, manuals, runbooks, install docs, procedures, and help text in STE; technical writing review and STE conformance audits with rule IDs and severities; word questions such as 'Is utilize allowed in ASD-STE100?' or 'is this an approved word?'; approved words, part of speech, technical nouns and technical verbs, a DOCS_TERMS.md term list; sentence length (20/25 words), active voice, imperative steps, WARNING/CAUTION/NOTE safety instructions, punctuation. DO NOT USE FOR: code, code comments, commit messages, chat replies, marketing copy, non-English text, ISO 999 indexes, RFC 3339 timestamps.
rfc3339-ixdtf
暂无简介
rfc3339-ixdtf
Audit code for RFC 3339 (Internet timestamps, the usual 'ISO timestamp format' of APIs and logs) and RFC 9557 (IXDTF: suffixes such as 2026-09-24T12:00:00+02:00[Europe/Paris] and [u-ca=hebrew] tags; Z now means 'local offset unknown'). USE FOR: parsing, validating or emitting these timestamps in any language (Python, JS and Temporal ZonedDateTime, Java, .NET, Go, Rust, Swift); choosing Z or +00:00 when the offset is unknown; leap second 23:59:60 legality; reviewing producers, consumers and schemas (JSON Schema/OpenAPI format date-time, protobuf Timestamp, API contracts); ServiceNow GlideDateTime and Fluent SDK date handling; running conformance vectors against a parser; scanning source for risky date-time APIs (strftime %z, literal 'Z'). DO NOT USE FOR: ISO 8601 durations, week or ordinal dates, intervals; HTTP-date or RFC 5322 email dates; time-zone arithmetic unrelated to serialization.
foxit-pr-check
Review a branch or pull request prepared for a Fox-IT open-source repository (fox-it/dissect.*, dissect.target, dissect.cstruct, flow.record, acquire, ...) against Fox-IT's contribution rules before it is pushed or opened: the Developing, Style guide and Tooling pages (docs.dissect.tools/en/latest/contributing/), the repository's own tox.ini, pyproject.toml (Ruff) and pull request template. USE FOR: commit message format (50-character imperative subject, 72-column body), fix/ and feature/ branches, one change per branch, the PR description and its closing keyword, running the repo's tox lint and tests, missing unit tests, type hints, names, cstruct definitions, dependency reasons, and whether the CLA (DissectBot) is accepted. DO NOT USE FOR: reviewing what the code does (correctness, design); repositories outside fox-it; accepting the CLA (only the author may).