Docs-as-Code 负责人套件
文档计划、信息架构、风格指南、术语库、贡献指南、评审清单、llms.txt、内容审计、文档指标、本地化与已知问题。
规划
Documentation Plan Template
标准Docs plan: audiences and tasks, deliverables inventory, IA, style, pipeline, review, localisation, accessibility, metrics, optional agile delivery and docs DoD
Structure aligned with ISO/IEC/IEEE 26511:2018 and 26515:2018; DiátaxisDocumentation Information Architecture Template (Diátaxis, llms.txt)
完整Docs site map and IA spec: audiences, Diátaxis content-type map, navigation, site-map tree, URL scheme, versioning, search facets, redirects, llms.txt
Diátaxis; llms.txt proposal (2026-08-10); ISO/IEC/IEEE 26514:2022Technical Writing Style Guide Template
标准Tech writing style guide: voice, grammar Do/Don't, terminology, UI and code conventions, procedures, inclusive language, Vale rule mapping, further reading
Vale 3.x rule mapping; Google developer documentation style guide and Microsoft Writing Style Guide as further readingTermbase Template (ISO 704, TBX)
完整Concept-oriented terminology register: definition rules, usage status, context, source, relations, per-locale equivalents, do-not-translate terms, TBX export
ISO 704:2022; ISO 30042:2019 (TBX)
构建
Docs Contribution Guide Template (Vale, markdownlint)
完整Docs-as-code contributing: repo layout, PR flow, preview, front matter schema, Vale vocabularies, markdownlint-cli2, link checks, alt text, review, release
Vale v3; markdownlint-cli2 0.24; Diátaxis; WCAG 2.2Documentation Review Checklist Template (WCAG 2.2, Diátaxis)
完整Docs review gate: roles, severity, accuracy, task test, style, terms, links, code samples, WCAG 2.2, localisation, Diátaxis type, findings, sign-off
ISO/IEC/IEEE 26513:2017 (structure); WCAG 2.2; Diátaxisllms.txt Template for LLM-Friendly Docs
精简llms.txt site index for language models: H1, summary, link-list sections, Optional section, llms-full.txt, .md page mirrors, rel alternate/describedby discovery
llms.txt proposal v2 (llmstxt.org, modified 2026-08-10)
评估
Documentation Content Audit Template (Inventory, ROT)
完整Docs content audit: criteria, page inventory with owner, last verified, signals, accuracy, ROT verdict and action, findings, gaps, remediation, redirects
ISO/IEC/IEEE 26511:2018 and 26513:2017 (structure); WCAG 2.2Docs Metrics Report Template (Privacy-First Docs Health)
完整Docs health report: coverage, freshness, quality (lint, links, accessibility), findability, usefulness, support impact, scorecard, actions, privacy-first
ISO/IEC/IEEE 26511:2018 (structure); WCAG 2.2; GPC
发布与移交
Localization Brief Template (ISO 17100, XLIFF)
完整Translation brief: locales, source freeze, scope, termbase and do-not-translate list, style per locale, MT post-editing policy, i18n readiness, LQA, schedule
ISO 17100:2015; ISO 18587:2017; XLIFF 2.1Release Notes Template
标准Release notes: highlights, features, fixes, breaking changes with migration, deprecations with deprecation and sunset dates, CVE fixes, known issues, upgrade steps
Semantic Versioning 2.0.0; RFC 9745 and RFC 8594 headersKnown Issues Register Template
完整Living known-issues register: ID, symptom, affected versions and platforms, workaround, status, fix version, links, publication and review rules
ISO/IEC/IEEE 26514:2022 (structure)