documentation-standards
FeaturedKB conventions: YAML frontmatter, 10-category taxonomy (reference/howto/procedures/troubleshooting/best-practices/decisions/runbooks/planning/business/templates). Triggers: kb/, SOP, runbook, howto, frontmatter, knowledge base.
Install
Quality Score: 94/100
Skill Content
Details
- Author
- softspark
- Repository
- softspark/ai-toolkit
- Created
- 5 months ago
- Last Updated
- yesterday
- Language
- Python
- License
- Apache-2.0
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
documentation-standards
Use whenever writing, reviewing, or restructuring a Markdown document in this knowledge base: choosing YAML front matter fields, a document type (STD, GUIDE, ADR, COMPETENCY, and so on), or a lifecycle status (Idea through Archived); naming a new file; deciding whether a design or feature doc needs a Mermaid sequenceDiagram or stateDiagram-v2 block and what that diagram must show; formatting cross-references, reference-style links, or anchors; writing or reviewing a table; or resolving which document canonically owns a topic. This is the cross-cutting documentation-formatting authority every stage skill (Design, Documentation, Implementation, and others) defers to for these rules rather than restating them — it is not itself a stage and does not gather requirements or write code.
documentation-standards
Structure, tone, and formatting conventions for writing technical docs that stay accurate and get actually read.
ki-specs
Codify, audit, and maintain Specifications — the behaviour-level contract of what a system does — in any Knowledge Islands repo. Specifications live in `docs/specs/`, flat one-file-per-area, with an `index.md` that defines the ID scheme and areas table. Each requirement is a `### <PREFIX>-NNN — title` heading carrying one RFC-2119 (MUST / SHOULD / MAY) statement and a `_Verify:_` test hook; IDs are append-only and never reused; an unnumbered `## Gaps` section holds the backlog. Decisions capture the why (`ki-decision-records`), specifications the what, guides the how (`ki-guides`), and roadmap items the when (`ki-work-roadmap`). Use when writing or auditing a specification. Triggers: "write a specification", "spec this behaviour", "audit specifications", "add a requirement", "what does the system do". Off-ramps: ki-decision-records (the governing decisions a requirement cites), ki-guides (practical procedure), ki-work-roadmap (planned work), ki-authoring (Markdown/TOML style).