Markdown Editor

Docs-as-Code 리드 키트

문서화 계획, 정보 아키텍처, 스타일 가이드, 용어집, 기여 가이드, 검토 체크리스트, llms.txt, 콘텐츠 감사, 문서 지표, 현지화, 알려진 문제.

1단계

계획

  1. 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átaxis
  2. Documentation 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:2022
  3. Technical 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 reading
  4. Termbase 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)
2단계

구축

  1. 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.2
  2. Documentation 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átaxis
  3. llms.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)
3단계

평가

  1. 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.2
  2. Docs 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
4단계

릴리스와 이관

  1. 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.1
  2. Release 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 headers
  3. Known 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)