documentation-standards

Featured

KB 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.

Data & Documents 174 stars 21 forks Updated yesterday Apache-2.0

Install

View on GitHub

Quality Score: 94/100

Stars 20%
75
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Standards Auto-loaded knowledge skill enforcing KB document conventions across all agents and skills. ## Frontmatter Specification (MANDATORY) Every document in `kb/` MUST start with YAML frontmatter: ```yaml --- title: "Document Title" # REQUIRED — English, descriptive category: reference # REQUIRED — one of the 10 valid categories service: ai-toolkit # REQUIRED — service identifier tags: [tag1, tag2, tag3] # REQUIRED — minimum 1, recommended 3+ last_updated: "YYYY-MM-DD" # REQUIRED — ISO format created: "YYYY-MM-DD" # REQUIRED — creation date description: "One-line summary." # REQUIRED — for search indexing version: "1.0.0" # optional — semver --- ``` **All 7 fields above are REQUIRED.** Documents without valid frontmatter **fail `scripts/validate.py` and block CI**. ### `section`: a legacy alias, not a second field Older documents and the `kb-migration` SOP write `section:` where this specification writes `category:`. Both names are read in the wild, so a document may carry both — and when it does **they must hold the same value**. A document filed as `category: reference` and `section: howto` is indexed twice, found once, and the reader gets whichever the index ranked higher. New documents should write `category:`. `section:` is accepted, never required, and never authoritative on its own. ## C...

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

Data & Documents Listed

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.

0 Updated 1 months ago
BhangeeF16
AI & Automation Listed

documentation-standards

Structure, tone, and formatting conventions for writing technical docs that stay accurate and get actually read.

1 Updated 4 days ago
niels-emmer
Testing & QA Listed

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).

0 Updated 2 days ago
knowledgeislands