Obsidian Writer
Atmosphere/atmosphere
Write well-formatted notes to the atmosphere-vault Obsidian knowledge base.
KB conventions: YAML frontmatter, 10-category taxonomy (reference/howto/procedures/troubleshooting/best-practices/decisions/runbooks/planning/business/templates).
Install Documentation Standards
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install softspark/ai-toolkit documentation-standards --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .claude/skills && cp -r skills-src/app/skills/documentation-standards .claude/skills/documentation-standards && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .claude/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standardsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install softspark/ai-toolkit documentation-standards --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .agents/skills && cp -r skills-src/app/skills/documentation-standards .agents/skills/documentation-standards && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .agents/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install softspark/ai-toolkit documentation-standards --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/app/skills/documentation-standards .cursor/skills/documentation-standards && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .cursor/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/softspark/ai-toolkit.git --path app/skills/documentation-standards--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install softspark/ai-toolkit documentation-standards --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/app/skills/documentation-standards .gemini/skills/documentation-standards && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .gemini/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install softspark/ai-toolkit documentation-standardsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .github/skills && cp -r skills-src/app/skills/documentation-standards .github/skills/documentation-standards && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .github/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add softspark/ai-toolkit --skill documentation-standards -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install softspark/ai-toolkit documentation-standards --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/softspark/ai-toolkit.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/app/skills/documentation-standards .opencode/skills/documentation-standards && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "documentation-standards" agent skill from https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards into .opencode/skills/documentation-standards/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-standards", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
documentation-standards- GitHub stars
- 179
- Token cost
- ~1.8k tokens
- SKILL.md length
- 549 words
- Files
- 1
- Skills in repo
- 112
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
KB conventions: YAML frontmatter, 10-category taxonomy (reference/howto/procedures/troubleshooting/best-practices/decisions/runbooks/planning/business/templates).
- Tasks that involve Runbooks and postmortems
- SKILL.md covers Frontmatter Specification…, Category Taxonomy, Naming Conventions and Language Rule, plus 4 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Tasks that involve Operations and SOPs
What it does
Documentation Standards is an agent skill from softspark/ai-toolkit. 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.
Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in DevOps & Cloud, covering Runbooks and postmortems, Operations and SOPs and Knowledge bases. The repository describes itself as: Professional-grade AI coding toolkit: 94 skills, 44 agents, multi-platform (Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Roo Code, Aider, Augment, Antigravity, Codex CLI… The licence is Apache-2.0.
When your agent uses it
- Tasks that involve Runbooks and postmortems
- Tasks that involve Operations and SOPs
- Tasks that involve Knowledge bases
Example prompts
- “/documentation-standards”
Requirements
- Pre-approved tools (allowed-tools): Read
What it can do on your machine
Read from SKILL.md and the folder at commit d64db2b. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
Read
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are yaml and bash).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Documentation Standards loads about 1.8k tokens when it runs. Until then it costs about 63 tokens; SKILL.md has 549 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from softspark/ai-toolkit at commit d64db2b, republished under its Apache-2.0 licence (© softspark). 549 words, ~1,813 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-standards/SKILL.md (or your agent's skills folder).- name
- documentation-standards
- description
- 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.
- allowed-tools
- Read
- effort
- medium
- user-invocable
- false
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:
---
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.
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 a person follows: release, migration, review | sop-maintenance.md, sop-release.md |
troubleshooting | kb/troubleshooting/ | Problem resolution, debugging guides | database-connection-issues.md |
best-practices | kb/best-practices/ | Guidelines, recommendations, standards | security-checklist.md |
decisions | kb/decisions/ | Architecture decision records and design rationale | adr-004-kb-migration.md |
runbooks | kb/runbooks/ | Procedures run against a live system, usually under pressure | deployment.md, incident-response.md |
planning | kb/planning/ | Roadmaps, PRDs, work not yet done | q3-roadmap.md |
business | kb/business/ | Domain model, requirements, use cases, user stories | domain-model.md, user-stories.md |
templates | kb/templates/ | Reusable document templates | adr-template.md, sop-template.md |
Rule: A document filed under one of the directories above MUST declare that
category. The rule is scoped to those directories deliberately: kb/history/
and kb/summaries/ are lifecycle and runtime locations rather than types, and a
finished plan filed under history/completed/ is still a planning document.
Templates carry placeholders on purpose. A file under templates/ exists to
be copied, so a literal YYYY-MM-DD date and [placeholder] body text are
correct there rather than defects. Every other convention still applies.
This taxonomy lives in three places: ai-toolkit's scripts/validate.py,
rag-mcp's scripts/validate_kb_frontmatter.py, and this document. They are one
list, and a change belongs in all three.
Show full SKILL.md (226 more words)Show less
Naming Conventions
- Filename: kebab-case, descriptive, no dates (
merge-friendly-install-model.md) - Title: English, clear, matches filename semantics
- No prefixes: no
001-, noYYYY-MM-DD-in filenames (dates go in frontmatter) - Max length: keep filenames under 60 characters
Language Rule
All KB content MUST be in English. No exceptions for:
- Document titles
- Body content
- Code comments within docs
- Table headers and descriptions
Quality Standards
Required for every KB document:
- Valid YAML frontmatter with all 7 required fields
- Category matches directory
- Written in English
- Title is clear and descriptive
- Content is actionable (not just placeholders)
Required for procedural docs (howto, procedures):
- Prerequisites listed
- Steps are numbered
- Commands are copy-pasteable
- Verification section present
Required for troubleshooting docs:
- Symptoms described
- Root cause identified
- Resolution steps provided
- Prevention notes included
Templates
Reference Document
---
title: "AI Toolkit - [Topic]"
category: reference
service: ai-toolkit
tags: [topic, subtopic]
version: "1.0.0"
created: "YYYY-MM-DD"
last_updated: "YYYY-MM-DD"
description: "Brief summary."
---
# [Topic]
## Overview
[What this document covers]
## Details
[Technical content]
## Related
- [Other relevant KB docs]How-To Guide
---
title: "How to [Task]"
category: howto
service: ai-toolkit
tags: [howto, task-name]
created: "YYYY-MM-DD"
last_updated: "YYYY-MM-DD"
description: "Step-by-step guide for [task]."
---
# How to [Task]
## Prerequisites
- [Requirement]
## Steps
### 1. [Action]
[Instructions + commands]
### 2. [Action]
[Instructions + commands]
## Verification
[How to confirm success]
## Troubleshooting
| Problem | Solution |
|---------|----------|
| [Error] | [Fix] |SOP / Procedure
---
title: "SOP: [Process Name]"
category: procedures
service: ai-toolkit
tags: [sop, process-name]
created: "YYYY-MM-DD"
last_updated: "YYYY-MM-DD"
description: "Standard procedure for [process]."
---
# SOP: [Process Name]
## Purpose
[Why this procedure exists]
## Prerequisites
- [Requirement]
## Procedure
### Step 1: [Action]
[Detailed instructions]
## Verification
[How to verify success]
## Rollback
[How to revert if needed]Validation
# Validates ALL kb/**/*.md frontmatter (title, category, service, tags, created, last_updated, description)
scripts/validate.py
# Checks: required fields present, category is valid, tags non-emptyValid categories are the eight in the table above. scripts/validate.py holds
the same set in VALID_KB_CATEGORIES; the two are the same list in two places
and a change belongs in both.
Anti-Patterns
| Anti-Pattern | Problem | Fix |
|---|---|---|
| No frontmatter | Blocks CI, not indexed | Add frontmatter with all required fields |
| Wrong category | Confuses search | Match category: to directory name |
| Non-English content | Inconsistent KB | Translate to English |
| Date in filename | Clutters, becomes stale | Use created: in frontmatter |
| Empty tags | Hurts search relevance | Add at least 1 meaningful tag |
| Placeholder content | Wastes reader time | Write real content or don't create the doc |
© softspark, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in app/skills/documentation-standards of softspark/ai-toolkit.
Open the folder on GitHubat commit d64db2b
Compare with similar skills
Documentation Standards next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Documentation Standards this skillsoftspark/ai-toolkit | 179 | — | ~1.8k | Automated safety check: Pass | Apache-2.0 | |
| Obsidian WriterAtmosphere/atmosphere | 3.8k | — | ~2.6k | Automated safety check: Pass | Apache-2.0 | |
| Pi Runbook WriterPr1p/pi-runbook | 143 | — | ~796 | Automated safety check: Pass | None | |
| Sop Creatorcoleam00/second-brain-skills | 832 | — | ~1.5k | Automated safety check: Pass | None | |
| Migrateguhcostan/claude-mega-brain | 126 | — | ~975 | Automated safety check: Pass | MIT | |
| Om QA Buddyopen-mercato/skills | 221 | — | ~1.9k | Automated safety check: Notes | MIT |
Similar skills
Pi Runbook Writer
Pr1p/pi-runbook
A skill your agent uses when creating, editing, or polishing pi-runbook content: README/index pages, docs, journal notes, experiments, bilingual documentation, source-reading summaries…
Sop Creator
coleam00/second-brain-skills
Create runbooks, playbooks, and technical documentation for engineering teams.
Migrate
guhcostan/claude-mega-brain
Scan the project and migrate existing documentation into OKF format.
Om QA Buddy
open-mercato/skills
Runs a manual QA session for a PR, issue, or branch — publishes an interactive runbook the tester works through in parallel from the moment a plan exists, updated with AI verdicts and bugs at the end.
Runbook Creation
sickn33/agentic-awesome-skills
Create operational runbooks and standard operating procedures.
More from softspark/ai-toolkit
All 112 skills in this repoPrepare Test Env
softspark/ai-toolkit
Prepare or verify a project QA environment with source identity, readiness, browser access, evidence paths and owned cleanup.
A11y Validate
softspark/ai-toolkit
Accessibility validator: WCAG 2.1 AA, EN 301 549, EAA. An agent skill from softspark/ai-toolkit.
Analyze
softspark/ai-toolkit
Analyzes code quality, complexity, patterns across codebase.
Autonomous Dev
softspark/ai-toolkit
Drives a brief, specification, issue or existing PR through implementation, review, tests and QA to a ready PR.
Brand Voice
softspark/ai-toolkit
Direct technical voice for docs, README, user-facing text. An agent skill from softspark/ai-toolkit.
CI
softspark/ai-toolkit
Detect/generate/debug CI pipeline config (GitHub Actions, GitLab CI).
Related
Categories
Questions about Documentation Standards
What does Documentation Standards do?
KB conventions: YAML frontmatter, 10-category taxonomy (reference/howto/procedures/troubleshooting/best-practices/decisions/runbooks/planning/business/templates). Documentation Standards is an agent skill from softspark/ai-toolkit. KB conventions: YAML frontmatter, 10-category taxonomy (reference/howto/procedures/troubleshooting/best-practices/decisions/runbooks/planning/business/templates).
When should I use Documentation Standards?
Documentation Standards fits situations like: tasks that involve Runbooks and postmortems; tasks that involve Operations and SOPs; tasks that involve Knowledge bases.
How do I install Documentation Standards in Claude Code?
Run `npx skills add softspark/ai-toolkit --skill documentation-standards -a claude-code`. Or copy the skill folder (app/skills/documentation-standards in softspark/ai-toolkit) into .claude/skills/documentation-standards in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Standards in Codex?
Run `npx skills add softspark/ai-toolkit --skill documentation-standards -a codex`. Or copy the skill folder (app/skills/documentation-standards in softspark/ai-toolkit) into .agents/skills/documentation-standards in your project. Codex loads it when a task matches its description.
Can I use Documentation Standards in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add softspark/ai-toolkit --skill documentation-standards -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-standards, .gemini/skills/documentation-standards, .github/skills/documentation-standards and .opencode/skills/documentation-standards in your project.
What does Documentation Standards need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Standards is instructions for the agent only. Its frontmatter pre-approves these tools: Read.
Does Documentation Standards access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Documentation Standards safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Documentation Standards use?
Documentation Standards is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation Standards use?
About 1.8k tokens (SKILL.md is roughly 7.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Documentation Standards?
Skills that share tags, products or a category with Documentation Standards: Obsidian Writer (Atmosphere/atmosphere, 3.8k stars), Pi Runbook Writer (Pr1p/pi-runbook, 143 stars), Sop Creator (coleam00/second-brain-skills, 832 stars) and Migrate (guhcostan/claude-mega-brain, 126 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Standards?
softspark (a GitHub user) maintains it in softspark/ai-toolkit, which has 179 GitHub stars. The repository holds 112 skills in this directory. The repository was last updated on October 7, 2026.
Source: softspark/ai-toolkit on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.