project-docs
/project-docs
Full SDLC documentation toolchain for software projects — pre-development through post-release. Scaffolds numbered folder structures, generates Product Specs via interview, creates versioned roadmaps (Markdown table + Mermaid Gantt + GitHub Milestones + phase-based), builds support clusters (FAQ, triage workflow, SLA, post-mortem, deprecation), validates documentation, generates health reports with SDLC coverage scoring, and creates release notes from git logs. Use this skill whenever the user asks to create, scaffold, validate, or health-check project documentation — including: "set up docs f
- Author
- nasrulhazim ↗
- Repository
- claude ↗
- Licence
- MIT
- Last repository change
- 27.10.2026
Assessment and security
- Files in this package
- 4
- Scripts
- 0
- HTML comments
- 2
- URLs in SKILL.md
- 3
No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
- SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.
What it does and when to use it
Full SDLC documentation toolchain for software projects — pre-development through post-release. Scaffolds numbered folder structures, generates Product Specs via interview, creates versioned roadmaps (Markdown table + Mermaid Gantt + GitHub Milestones + phase-based), builds support clusters (FAQ, triage workflow, SLA, post-mortem, deprecation), validates documentation, generates health reports with SDLC coverage scoring, and creates release notes from git logs. Use this skill whenever the user asks to create, scaffold, validate, or health-check project documentation — including: "set up docs f
Original author description
Full SDLC documentation toolchain for software projects — pre-development through post-release. Scaffolds numbered folder structures, generates Product Specs via interview, creates versioned roadmaps (Markdown table + Mermaid Gantt + GitHub Milestones + phase-based), builds support clusters (FAQ, triage workflow, SLA, post-mortem, deprecation), validates documentation, generates health reports with SDLC coverage scoring, and creates release notes from git logs. Use this skill whenever the user asks to create, scaffold, validate, or health-check project documentation — including: "set up docs f
How it works
- Command Reference
- SDLC Folder Structure
- 1. Scaffold New Documentation
- 2. /docs spec — Product Specification (Interview Mode)
- 3. /docs roadmap — Versioned Roadmap
- 4. Reorganize, Validate, Update TOC
- 5. /docs health — Health Report
- 6. /docs support — Support Cluster
- 7. /docs runbook — Ops Runbook
- 8. Release Notes
SKILL.md preview
---
name: project-docs
metadata:
compatible_agents: [claude-code]
tags: [documentation, sdlc, laravel, php, markdown, badges, release-notes]
description: >
Full SDLC documentation toolchain for software projects — pre-development through post-release.
Scaffolds numbered folder structures, generates Product Specs via interview, creates versioned
roadmaps (Markdown table + Mermaid Gantt + GitHub Milestones + phase-based), builds support
clusters (FAQ, triage workflow, SLA, post-mortem, deprecation), validates documentation,
generates health reports with SDLC coverage scoring, and creates release notes from git logs.
Use this skill whenever the user asks to create, scaffold, validate, or health-check project
documentation — including: "set up docs for my Laravel package", "write a product spec",
"generate a roadmap", "create an FAQ", "write a post-mortem", "generate a release note",
"check my docs health", "add badges", "scaffold a support runbook", or "deprecate my package".
Compatible with the nasrulhazim/claude-docs Claude Code slash command.
---
# Claude Docs — Full SDLC Documentation Toolchain
Covers the complete software development lifecycle: **Pre → During → Post**.
All outputs use the numbered folder structure compatible with `/docs` Claude Code slash command.
## Command Reference
| Command | Phase | Description |
|---|---|---|
| `/docs` | Any | Auto-detect project type, scaffold full structure |
| `/docs scaffold <type> [--phase]` | Any | Scaffold by project type + SDLC phase |
| `/docs spec` | Pre | Interview → generate Product Specification |
| `/docs roadmap` | Pre | Generate versioned roadmap (all formats) |
| `/docs reorganize` | Any | Reorganize existing docs into numbered standard |
| `/docs validate` | Any | Validate against standards, report issues |
| `/docs update-toc` | Any | Refresh all README.md table of contents |
| `/docs health` | Any | SDLC coverage + quality health report |
| `/docs support` | Post | Scaffold support cluster (FAQ, triage, SLA, etc.) |
| `/docs runbook` | Post | Generate ops/deployment runbook with checklists |
| `/docs release-note [--tldr]` | Post | Release notes from git log |
| `/docs srs` | Pre | Link to `project-requirements` skill for full SRS generation |
| `/docs stories` | Pre | Link to `project-requirements` skill for user stories |
| `/docs ci-cd` | Post | Generate CI/CD pipeline documentation |
---
## SDLC Folder Structure
```
docs/
├── README.md ← Master index
├── 00-product/ ← Pre: spec, PRD, roadmap
│ ├── README.md
│ ├── 01-product-spec.md
│ ├── 02-requirements.md
│ ├── 03-roadmap.md
│ ├── 04-srs.md
│ └── 05-user-stories.md
├── 01-architecture/ ← Pre/During: design, ADRs
│ ├── README.md
│ ├── 01-overview.md
│ ├── 02-patterns.md
│ ├── 03-data-layer.md
│ └── adr/
│ └── 0001-record-architecture-decisions.md
├── 02-development/ ← During: setup, workflows, testing
│ ├── README.md
│ ├── 01-getting-started.md
│ ├── 02-workflows.md
│ ├── 03-testing.md
│ └── 04-livewire-components.md
├── 03-deployment/ ← Post: deploy, ops runbook
│ ├── README.md
│ ├── 01-overview.md
│ ├── 02-runbook.md
│ └── 03-ci-cd.md
├── 04-api/ ← During/Post: contracts
│ ├── README.md
│ └── 01-endpoints.md
└── 05-support/ ← Post: FAQ, triage, SLA, post-mortem
├── README.md
├── 01-faq.md
├── 02-support-workflow.md
├── 03-sla.md
├── 04-post-mortem-template.md
└── 05-deprecation.md
```
### Phase Filtering for Scaffold
| Flag | Folders Generated |
|---|---|
| `--phase pre` | `00-product/`, `01-architecture/` |
| `--phase during` | `02-development/`, `04-api/` |
| `--phase post` | `03-deployment/`, `05-support/` |
| `--phase all` (default) | All folders |
---
## 1. Scaffold New Documentation
### Step 1: Auto-Detect Project Type
| Signal | Project Type |
|---|---|
| `composer.json` + Laravel deps, `artisan` | `laravel` |
| `composer.json` + Livewire deps, Flux UI | `laravel-livewire` |
| OpenAPI/Swagger, REST/GraphQL description | `api` |
| `bin/` directory, CLI flags/commands | `cli` |
| "package", "library", "SDK", "client library" | `sdk` |
| Frontend + backend together | `fullstack` |
| `pyproject.toml`, `requirements.txt` | `python` |
| `Cargo.toml` | `rust` |
| `go.mod` | `go` |
| `Gemfile` | `ruby` |
| `*.csproj`, `*.sln` | `dotnet` |
| `pom.xml`, `build.gradle` | `java` |
| `pubspec.yaml` | `dart` |
| `mix.exs` | `elixir` |
If ambiguous, ask: "What type of project is this?"
### Step 2: Read Reference Files
- `references/scaffolds.md` — file contents per project type (during-phase dev docs)
- `references/sdlc-templates.md` — pre and post phase document templates
> **Livewire projects:** For `laravel-livewire` type projects, also scaffold Livewire component
> documentation in `02-development/`:
> - `04-livewire-components.md` — Component inventory, props, events, patterns
### Step 3: Generate Files
Apply [Linting Rules](#linting-rules) to every file. Present grouped by phase.
Always include root `README.md` with mandatory badges — see `references/badges.md`.
---
## 2. `/docs spec` — Product Specification (Interview Mode)
### Interview Phase
Ask questions in **three blocks**, one at a time:
**Block 1 — Core Identity**
- What is the product/feature name?
- What problem does it solve? (one sentence)
- Who is the target user? (be specific)
**Block 2 — Scope**
- What are the 3–5 key features in scope for this version?
- What is explicitly out of scope?
- What are the hard constraints? (tech stack, deadline, budget, compliance)
**Block 3 — Success**
- How will you know it's working? (metrics, KPIs)
- What does the minimum viable version look like?
- Are there any existing systems this must integrate with?
After Block 3, confirm: "Here's what I've captured — shall I generate the spec?"
### Generate
Read `references/sdlc-templates.md` → **Product Specification** section.
Populate every field from interview answers.
Mark genuinely unknown fields as `> ⚠️ TBD — needs decision` rather than leaving blank.
Output: `docs/00-product/01-product-spec.md`
### Requirement Design Phase Integration
For full Software Requirements Specification (SRS) and user story generation, this skill
delegates to the `project-requirements` skill:
- `/docs srs` — Invokes `project-requirements` to generate a complete SRS document.
Output: `docs/00-product/04-srs.md`
- `/docs stories` — Invokes `project-requirements` to generate user stories with acceptance criteria.
Output: `docs/00-product/05-user-stories.md`
If the `project-requirements` skill is not available, prompt the user to install it or
provide requirements manually for inclusion in the product spec.
---
## 3. `/docs roadmap` — Versioned Roadmap
Ask the user for: version targets, milestone names, dates or quarters, features per version.
If no dates given, use "Q1 2026", "Q2 2026" etc.
Generate all four formats in `docs/00-product/03-roadmap.md`.
Read `references/sdlc-templates.md` → **Roadmap** section for the full template.
**Format 1 — Markdown Version Table**
| Version | Milestone | Target | Status | Key Features |
|---|---|---|---|---|
| v0.1 | Alpha | Q1 2026 | 🔵 Planned | ... |
**Format 2 — Mermaid Gantt**
```mermaid
gantt
title Product Roadmap
dateFormat YYYY-MM-DD
section Alpha
Core features :2026-01-01, 2026-02-28
```
**Format 3 — GitHub Milestones JSON**
Fenced block the user can paste into a GitHub Milestones import script:
```json
[{ "title": "v0.1 Alpha", "description": "...", "due_on": "2026-02-28T00:00:00Z" }]
```
**Format 4 — Phase Summary**
```
Alpha (v0.1) → Core features, internal testing
Beta (v0.2) → External testing, feedback loop
GA (v1.0) → Production-ready, full docs, SLA active
```
---
## 4. Reorganize, Validate, Update TOC
### Reorganize
Map current files → numbered SDLC structure. Show mapping first, get confirmation, then generate.
### Validate
| Check | Pass Condition |
|---|---|
| Numbered folders | All `docs/` subdirs prefixed `00-` through `05-` |
| README in each folder | Every `docs/*/` has a `README.md` |
| Main TOC | `docs/README.md` links all sections |
| Single H1 | Each `.md` has exactly one `#` heading |
| ATX headers | `#` style, not underline |
| Fenced code blocks | Triple backticks + language identifier |
| Line length | Prose ≤ 120 chars |
| Badges | Root `README.md` has version + license badges |
| SDLC coverage | `00-product/`, `02-development/`, `05-support/` exist |
### Update TOC
Scan each folder's `.md` files in numbered order. Replace between `<!-- TOC -->` /
`<!-- /TOC -->` markers, or insert after first `##` heading.
---
## 5. `/docs health` — Health Report
### Quality Score (60 pts)
| Metric | Max |
|---|---|
| Folder structure + README per folder | 15 |
| Badge compliance | 10 |
| Code block quality (language identifiers) | 10 |
| TOC completeness | 10 |
| Line length compliance | 10 |
| Single H1 per file | 5 |
### SDLC Coverage Score (40 pts)
| Phase | Folder | Max |
|---|---|---|
| Pre-Dev: Product | `00-product/` with spec + roadmap | 15 |
| During: Development | `02-development/` with getting-started + testing | 10 |
| Post: Support | `05-support/` with FAQ + workflow | 15 |
### Output Format
```
Documentation Health Report — [Project Name]
============================================
Generated: [date] | Project Type: [type]
📊 Overall Score: 72/100
Quality (48/60)
Folder Structure ████████████░░ 12/15
Badge Compliance ███████░░░ 7/10
Code Blocks ██████████ 10/10
TOC ████████░░ 8/10
Line Length █████████░ 9/10
Single H1 █████ 5/5
SDLC Coverage (24/40)
Pre-Dev / Product ████████░░░░░░░ 8/15 ← missing roadmap
During / Dev ██████████ 10/10
Post / Support ██████░░░░░░░░░ 6/15 ← missing SLA + post-mortem
Issues Found:
❌ [HIGH] 05-support/ missing — run /docs support
⚠️ [MED] 00-product/03-roadmap.md missing — run /docs roadmap
⚠️ [MED] No license badge in root README.md
ℹ️ [LOW] 4 files exceed 120-char line limit
Recommendations:
1. /docs support → scaffold full support cluster
2. /docs roadmap → generate versioned roadmap
3. Add badge: [](LICENSE)
```
---
## 6. `/docs support` — Support Cluster
Generates five files under `docs/05-support/`.
Read `references/sdlc-templates.md` → **Support** section for each template.
Ask for project name and context before generating.
| File | Content |
|---|---|
| `01-faq.md` | Common questions, troubleshooting, known limitations |
| `02-support-workflow.md` | Issue triage flow, response process, escalation path |
| `03-sla.md` | Severity levels, response times, resolution targets |
| `04-post-mortem-template.md` | Incident timeline, root cause, action items |
| `05-deprecation.md` | EOL announcement, migration guide, timeline |
---
## 7. `/docs runbook` — Ops Runbook
Ask: project type, hosting environment, deployment method (manual / CI-CD / Docker / k8s).
Read `references/sdlc-templates.md` → **Runbook** section.
Output: `docs/03-deployment/02-runbook.md`
Sections generated: pre-deploy checklist, deploy steps (numbered, atomic),
post-deploy verification, rollback procedure, emergency contacts.
---
## 8. Release Notes
User provides git log output (`git log --oneline --since="X"`).
| Prefix | Section |
|---|---|
| `feat:` / `feature:` | ✨ New Features |
| `fix:` / `bugfix:` | 🐛 Bug Fixes |
| `docs:` | 📚 Documentation |
| `refactor:` | ♻️ Refactoring |
| `perf:` | ⚡ Performance |
| `test:` | 🧪 Tests |
| `chore:` / `build:` / `ci:` | 🔧 Maintenance |
| `BREAKING CHANGE` | 💥 Breaking Changes |
Full: version header, summary table, categorised commits, contributor list.
`--tldr`: version, date, one-line per section, total count.
---
## Linting Rules
| Rule | Requirement |
|---|---|
| Headers | ATX style (`#` not underline) |
| Lists | Dash (`-` not `*` or `+`) |
| List indent | 2 spaces |
| Line length | Prose ≤ 120 chars; code exempt |
| H1 per file | Exactly one |
| Code blocks | Fenced, triple backtick + language identifier |
| Spacing | Blank line before/after headings and code blocks |
---
## Badge Standards
Mandatory on every root `README.md`:
```markdown
[](...)
[](LICENSE)
```
Full templates and project type badge matrix → `references/badges.md`.
---
## Reference Files
| File | Read When |
|---|---|
| `references/scaffolds.md` | Generating during-phase dev docs per project type |
| `references/sdlc-templates.md` | Pre-dev (spec, roadmap) or post-dev (support, runbook) |
| `references/badges.md` | Adding badges to any README |
Files in this package (4)
- SKILL.md 13 KB
- references/badges.md 5 KB
- references/scaffolds.md 9 KB
- references/sdlc-templates.md 18 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · nasrulhazim/claude | 100 | MIT |
| coco-research/coco | 100 | MIT |
| event4u-app/agent-config | 100 | MIT |
| GGaryyy/POBG | 100 | MIT |
| DPatta/project-docs-kit | 100 | MIT |
| DPatta/project-docs-kit | 100 | MIT |
| jezweb/claude-skills | 100 | MIT |
| waynesutton/builder-skills | 100 | Apache-2.0 |
| xstongxue/best-skills | 100 | Apache-2.0 |
Database snapshot: 13.11.2026 · package version a3eb3088f727 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100setup
This skill should be used when the user asks about "project setup", "project initialization", "repository setup", "new project", "bootstrap project", "project structure", "development environment", "toolchain setup", "project configuration", or needs guidance on setting up new… - 100k6-docs
Write or review k6 documentation across the three k6 repositories - k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes / changelog). Applies k6 doc style conventions, generates TypeScript type definitions, drafts release notes, and… - 100qa-baseline
Bootstrap the QA knowledge foundation for a repo: discover test files, coverage reports, CI test gates, and QA docs; configure adapters to external QA sources (test-case management, QA documentation, external test repos); then write two persistent guides — qa-strategy.md and… - 100create-project-documentation
Create or refresh a complete software-project documentation suite: README, ADRs, user guide, administrator guide, changelog, and versioned release notes, and record the upkeep rules for those documents in AGENTS.md. Use when a project needs launch documentation, a documentation… - 86openrig-docs
Use when you need OpenRig docs, spec library or SDLC facts. - 100sdlc-project-research
仅在用户明确要求基于仓库证据生成项目功能能力地图、能力盘点或持久研究包时使用;不要用于普通代码探索、repo onboarding、Git 历史问答或只读解释。