From cc-swiss-knife
This skill should be used when the user asks about "documentation templates", "doc structure", "README format", "API documentation format", "how to write tutorials", "documentation checklist", or when the documentation-writer agent needs templates and workflows for specific documentation types. Provides Diataxis-based templates, checklists, and examples for 7 documentation types.
npx claudepluginhub oshankhz/cc-swiss-knife --plugin cc-swiss-knifeThis skill uses the workspace's default tool permissions.
Templates, workflows, and checklists for creating documentation following Diataxis principles.
examples/api-docs-template.mdexamples/contributing-template.mdexamples/explanation-adr-template.mdexamples/good-adr.mdexamples/good-api-doc.mdexamples/good-readme.mdexamples/howto-template.mdexamples/quickstart-template.mdexamples/readme-module-template.mdexamples/readme-root-template.mdexamples/reference-docs-template.mdexamples/tutorial-template.mdreferences/adr-guidelines.mdreferences/api-docs-guidelines.mdreferences/contributing-guidelines.mdreferences/howto-guidelines.mdreferences/quickstart-guidelines.mdreferences/readme-guidelines.mdreferences/reference-guidelines.mdreferences/tutorial-guidelines.mdVerifies tests pass on completed feature branch, presents options to merge locally, create GitHub PR, keep as-is or discard; executes choice and cleans up worktree.
Guides root cause investigation for bugs, test failures, unexpected behavior, performance issues, and build failures before proposing fixes.
Writes implementation plans from specs for multi-step tasks, mapping files and breaking into TDD bite-sized steps before coding.
Templates, workflows, and checklists for creating documentation following Diataxis principles.
Use when:
| Quadrant | Purpose | Audience | Focus |
|---|---|---|---|
| Tutorial | Learning | Beginners | Hand-holding, confidence building |
| How-to | Goal completion | Practitioners | Steps to achieve specific goal |
| Reference | Information | Any level | Exhaustive, accurate lookup |
| Explanation | Understanding | Curious users | WHY, context, decisions |
| Type | Diataxis | When to Use | Guidelines | Template |
|---|---|---|---|---|
| README (root) | How-to | Project entry point | references/readme-guidelines.md | examples/readme-root-template.md |
| README (module) | Reference + How-to | Module documentation | references/readme-guidelines.md | examples/readme-module-template.md |
| Quick Start | How-to | Fast path to working | references/quickstart-guidelines.md | examples/quickstart-template.md |
| CONTRIBUTING | How-to | Guide contributors | references/contributing-guidelines.md | examples/contributing-template.md |
| API docs | Reference | Endpoint documentation | references/api-docs-guidelines.md | examples/api-docs-template.md |
| Tutorial | Tutorial | Onboarding, learning | references/tutorial-guidelines.md | examples/tutorial-template.md |
| How-to guide | How-to | Specific task completion | references/howto-guidelines.md | examples/howto-template.md |
| Reference | Reference | Exhaustive information | references/reference-guidelines.md | examples/reference-docs-template.md |
| Explanation/ADR | Explanation | Architecture decisions | references/adr-guidelines.md | examples/explanation-adr-template.md |
What does the reader need?
├─ Learn something new → Tutorial
├─ Accomplish a specific task → How-to
├─ Look up information → Reference
└─ Understand why/context → Explanation
Diataxis: How-to (goal: get project running)
Required Sections:
Checklist:
Guidelines: references/readme-guidelines.md
Template: examples/readme-root-template.md
Diataxis: How-to (goal: get running FAST)
When to Create: If README Quick Start section > 10 lines
Required Sections:
- [ ])Checklist:
Guidelines: references/quickstart-guidelines.md
Template: examples/quickstart-template.md
Diataxis: How-to (goal: enable contributions)
Required Sections:
Checklist:
Guidelines: references/contributing-guidelines.md
Template: examples/contributing-template.md
Diataxis: Reference + How-to hybrid
Required Sections:
Checklist:
Guidelines: references/readme-guidelines.md
Template: examples/readme-module-template.md
Diataxis: Reference (exhaustive, accurate)
Required Sections:
Checklist:
Guidelines: references/api-docs-guidelines.md
Template: examples/api-docs-template.md
Diataxis: Tutorial (learning-oriented)
Core Principles:
Required Sections:
Checklist:
Guidelines: references/tutorial-guidelines.md
Template: examples/tutorial-template.md
Diataxis: How-to (goal-oriented)
Core Principles:
Required Sections:
Checklist:
Guidelines: references/howto-guidelines.md
Template: examples/howto-template.md
Diataxis: Reference (information-oriented)
Core Principles:
Required Sections:
Checklist:
Guidelines: references/reference-guidelines.md
Template: examples/reference-docs-template.md
Diataxis: Explanation (understanding-oriented)
Core Principles:
Required Sections (ADR Format):
Checklist:
Guidelines: references/adr-guidelines.md
Template: examples/explanation-adr-template.md
Who is blocked without this doc?
What do they need?
Use the checklist for that doc type.
documentation-standards/
├── SKILL.md # This file - overview and checklists
├── references/ # Guidelines and rules for each doc type
│ ├── quickstart-guidelines.md
│ ├── contributing-guidelines.md
│ ├── readme-guidelines.md
│ ├── api-docs-guidelines.md
│ ├── tutorial-guidelines.md
│ ├── howto-guidelines.md
│ ├── reference-guidelines.md
│ └── adr-guidelines.md
└── examples/ # Concrete templates and working samples
├── quickstart-template.md
├── contributing-template.md
├── readme-root-template.md
├── readme-module-template.md
├── api-docs-template.md
├── tutorial-template.md
├── howto-template.md
├── reference-docs-template.md
├── explanation-adr-template.md
├── good-readme.md # Working example
├── good-api-doc.md # Working example
└── good-adr.md # Working example
All documentation should be accurate, minimal, and serve a single Diataxis purpose.