documentation-standards

Name: documentation-standards
Availability: InStock
Author: Oshan

Generate Diataxis-based templates and checklists for seven documentation types.

5|2|Updated Dec 26, 2025

Search Tags:#templates #documentation #adr #readme #tutorials #api-docs #Diataxis

One-click install

npx skills add https://github.com/OshanKHZ/cc-swiss-knife --skill documentation-standards-oshankhz

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/OshanKHZ/cc-swiss-knife/tree/main/02 - skills/documentation-standards
Command: npx skills add https://github.com/OshanKHZ/cc-swiss-knife --skill documentation-standards-oshankhz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and examples (resource) components.

What problem does it solve?

This Skill provides Diataxis-based templates, checklists, and examples for 7 documentation types, helping teams standardize documentation quality and reduce guesswork.

Core Features & Use Cases

Templates and patterns for README (root), README (module), Quick Start, CONTRIBUTING, API docs, Tutorial, How-to guide, Reference, and ADR
Guidelines and templates to ensure consistent structure, tone, and thoroughness
Ready-to-adapt examples and templates to accelerate documentation workflows

Quick Start

Explore the references and templates to scaffold and standardize documentation for your project. Use the included examples to bootstrap consistent docs quickly.