documentation-standards

Solid

KB conventions: YAML frontmatter, 5-category taxonomy (reference/howto/procedures/troubleshooting/best-practices). Triggers: kb/, SOP, runbook, howto, frontmatter, knowledge base.

AI & Automation 155 stars 19 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
73
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
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 5 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 `validate.sh` and block CI**. ## Category Taxonomy | Category | Directory | Purpose | Examples | |----------|-----------|---------|----------| | `reference` | `kb/reference/` | Technical specifications, catalogs, architecture notes, API docs | `agents-catalog.md`, `architecture-overview.md` | | `howto` | `kb/howto/` | Step-by-step task guides | `use-corrective-rag.md`, `configure-mcp-server.md` | | `procedures` | `kb/procedures/` | SOPs, runbooks, operational processes | `maintenance-sop.md`, `incident-response.md` | | `troubleshooting` | `kb/troubleshooting/` | Problem resolut...

Details

Author
softspark
Repository
softspark/ai-toolkit
Created
2 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category