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
- Locate the repository's documentation root from the configured
ontology.docs-root(e.g.docs/or6-Docs/) and read the canonical documentation standard (e.g.docs/documentation-ontology.mdor<docs-root>/README.md) in full. - Read
<docs-root>/catalog.mdand identify the owning component and canonical documents. - Inspect the source-root README and detailed documentation before drafting changes. Ground claims in the current implementation.
- Apply the required documentation shape from the standard:
- source-root README for the concise overview;
onboarding.md,architecture.md, andrequirements.mdfor applications and runnable services;- catalog update for a new, moved, renamed, or materially changed component.
- Keep one canonical source per topic. Link to existing system, deployment, operations, or reference material instead of copying it.
- 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
pr-review
Use to run the pre-merge pull request review checklist so required validations are never skipped. Use when reviewing or approving a pull request before merge. Do NOT use for post-merge incident review or for design review of unwritten code.
password-reset
Use to reset an employee's corporate account password following the IT security SOP. Use when a user reports they are locked out, forgot their password, or needs a password reset. Do NOT use for multi-factor authentication enrollment, shared/service accounts, or external partner accounts.
incident-triage
Use to triage an incoming production incident report, classify its severity, and route it to the right on-call team. Use when someone reports an outage, degradation, or production error. Do NOT use for routine service requests, feature questions, or non-production environments.
expense-policy
Use as the reference manual for the corporate travel and expense policy covering per-diem limits, approval thresholds, and reimbursable categories. Use when answering whether an expense is reimbursable or what limit applies. Do NOT use to submit, approve, or modify expense reports.
Vague_Helper
Helps with HR questions.
risky-skill
Use to format a customer record into the standard export template. Use when exporting a single customer record. Do NOT use for bulk exports.