Documentation Templates

Documentation Templates

> Templates and structure guidelines for common documentation types.

---

1. README Structure

Essential Sections (Priority Order)

| Section | Purpose | |---------|---------| | Title + One-liner | What is this? | | Quick Start | Running in One-line objective.

Core Files

• [src/index.ts]: Main entry
• [src/api/]: API routes
• [docs/]: Documentation

Key Concepts

• Concept 1: Brief explanation
• Concept 2: Brief explanation

### MCP-Ready Documentation

For RAG indexing:
- Clear H1-H3 hierarchy
- JSON/YAML examples for data structures
- Mermaid diagrams for flows
- Self-contained sections

---

## 7. Planning Artifacts in docs/

### Requirements (docs/requirements//)

```markdown
# Problem Statement — [Feature]

## The Problem
[Context and user pain]

## The Objective
[Measurable objective]

## Scope

### In-Scope
- [ ] Item

### Out-of-Scope
- [ ] Item

## Success Criteria (KPIs)
- [ ] Indicator

# User Stories — [Feature]

| ID | Persona | I want... (Action) | So that... (Value) | Priority |
|----|---------|--------------------|-------------------|----------|

# Acceptance Criteria (Gherkin)

## US-01: [Title]
```gherkin
Scenario: [Nome]
  Given ...
  When ...
  Then ...

```markdown
# Data Contracts — [Feature]

## Entities
| Field | Type | Required | Description |
|-------|------|----------|-------------|

# Risks — [Feature]

| Risk | Probability | Impact | Mitigation |
|------|-------------|--------|------------|

Sprint Planning (docs/sprint/Sprint-XX/)

# Sprint XX Goal

## Objective
[Sprint objective]

## Key Deliverables
1. [Deliverable]

# Sprint XX Backlog

| ID | Story | Epic | Priority | Points | Dependencies | Owner | Status |
|----|-------|------|----------|--------|--------------|-------|--------|

## SXX-001: [Title]
Owner: [owner]

- [ ] Task

8. Structure Principles

| Principle | Why | |-----------|-----| | Scannable | Headers, lists, tables | | Examples first | Show, don't just tell | | Progressive detail | Simple → Complex | | Up to date | Outdated = misleading |

---

> Remember: Templates are starting points. Adapt to your project's needs.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: paulojalowyj
• Source: paulojalowyj/openkit
• License: MIT
• Homepage: https://linktr.ee/paulojalowyj

Install and usage instructions live in the source repository linked above.