AGENT SKILL

app-docs-standard

Apply the repository documentation standard when creating or updating application, service, tool, or system documentation.

License 许可
MIT
最近更新
2026-11-15
Stars
★ 23
Forks
3

01 前言 Front Matter

name
app-docs-standard
license
MIT
description
Apply the repository documentation standard when creating or updating application, service, tool, or system documentation.

03 SKILL.md 正文

Application Documentation Workflow

Use this skill for documentation changes that affect an application, runnable service, tool, system boundary, or component README.

Required workflow

  1. Locate the repository's documentation root from the configured ontology.docs-root (e.g. docs/ or 6-Docs/) and read the canonical documentation standard (e.g. docs/documentation-ontology.md or <docs-root>/README.md) in full.
  2. Read <docs-root>/catalog.md and identify the owning component and canonical documents.
  3. Inspect the source-root README and detailed documentation before drafting changes. Ground claims in the current implementation.
  4. Apply the required documentation shape from the standard:
    • source-root README for the concise overview;
    • onboarding.md, architecture.md, and requirements.md for applications and runnable services;
    • catalog update for a new, moved, renamed, or materially changed component.
  5. Keep one canonical source per topic. Link to existing system, deployment, operations, or reference material instead of copying it.
  6. Validate Markdown style, internal links, catalog coverage, and the absence of secrets before delivery.

Deliverable

State the component documentation updated, the catalog impact, and the validation performed. If no documentation change is needed, state the reason explicitly.

04 同仓库更多 Skills