documentation
Maintain in-repo documentation for the widget host app: doc templates, ADRs, and architecture diagrams. Use when creating or updating docs under `docs/`, or when standardizing doc formats for contributors.
📖 中文导读:Maintain in-repo documentation for the widget host app: doc templates, ADRs, and architecture diagrams. Use when creating or updating docs under `docs/`, or when standardizing doc formats for contributors. 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: documentation
description: Maintain in-repo documentation for the widget host app: doc templates, ADRs, and architecture diagrams. Use when creating or updating docs under docs/, or when standardizing doc formats for contributors.
Documentation
Overview
Keep project documentation consistent and easy to maintain.
Definition of done (DoD)
- Doc has a clear purpose (decision, how-to, architecture, runbook)
- The “what/why/how” is explicit (no unexplained decisions)
- Links are relative and stable where possible
- If behavior changed, docs are updated in the same PR/change
Core areas
- Documentation templates
- ADRs (Architecture Decision Records)
- Architecture diagrams
Workflow
- Choose the appropriate template for the document type.
- Write concise, decision-oriented content.
- Keep diagrams in source control with editable sources.
- Link docs from README or a docs index.
Guidance
- Keep ADRs short and outcome-focused.
- Use Markdown for most docs.
- Store diagram sources alongside exports.
References
references/adr.mdfor ADR format.references/docs-templates.mdfor template guidance.references/architecture-diagrams.mdfor diagram conventions.