Skip to content
cccskills
FreePublished on GitHub

create-doc

Create a new documentation file following project standards. Detects overlap with existing docs before creating.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Create Documentation

Activation

This skill activates for:

  • Creating a new documentation file
  • Documenting a feature, a concept, or a component
  • /create-doc

Persona

Read .claude/roles/documentalist.md — adopt this profile and follow all its rules.

Workflow

Step 1: Clarify the Subject

If the subject is vague, ask:

  • Which component/feature to document?
  • Target audience: contributor, user, LLM?
  • Scope: reference, guide, architecture, or spec?

Step 2: Detect Duplicates

MANDATORY before any creation.

# List all existing docs
Glob docs/**/*.md

# Read the titles and H2/H3 of each file
# Compare with the requested subject

If an existing doc already covers the subject:

  • STOP — do not create a new file
  • Suggest updating the existing doc via /update-docs
  • Explain which file covers what

If partial overlap:

  • Identify precisely which sections already exist
  • The new doc must cover ONLY the missing content
  • Add links to existing sections

Step 3: Create the File

Apply the template from PERSONA.md:

---
title: <Title>
scope: reference | guide | architecture | spec
related:
  - src/path/to/source.ts
  - docs/RELATED-DOC.md
last-updated: YYYY-MM-DD
---

Writing rules:

  • English only
  • 1-2 summary sentences after the title
  • One section = one concept
  • Tables rather than lists for structured data
  • Code blocks rather than prose for technical details
  • Max 800 words — split if longer

Step 4: Naming

LocationConvention
docs/ top-levelSCREAMING-KEBAB.md (e.g., MCP-TOOLS-REFERENCE.md)
Subdirectorykebab-case.md (e.g., docs/mcp/architecture.md)

Step 5: Update the Index

Run /docs-index to regenerate docs/INDEX.md with the new file.

Anti-patterns

ForbiddenDo Instead
Duplicate existing contentLink to the canonical source
Doc > 800 wordsSplit into multiple files
Sections unrelated to the titleCreate a separate doc
Prose when a table sufficesUse a table
Mixing French and EnglishEverything in English

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Guide for creating optimized Claude Code agents. Use to design a new specialized agent, a swarm sub-agent, or a multi-agent workflow. Follows the Skill → Agent (preloaded skills) → Skill orchestration pattern.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

Anti-overengineering guide based on YAGNI. Use before adding an architectural pattern, during code review, or to challenge an overly complex implementation.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

Clean Architecture (Uncle Bob) guide for this project. Use when creating modules, entities, use cases, presenters, controllers, gateways, guards, services. Contains tactical patterns and structure conventions.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

Audit documentation for duplication, staleness, language issues, and verbosity. Read-only — produces an actionable report.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

Local auto-review of modified code (no GitLab/GitHub). Runs 5 sequential audits and generates a local report. Ideal for validating code before creating a MR/PR.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

Clean Code (Robert C. Martin) guide to produce and challenge code that is readable, durable, simple, and consistent. Covers naming, functions, comments, smells, and refactor heuristics. Complements `/solid` (SOLID principles) and `/anti-overengineering` (YAGNI/KISS). Activate during the REFACTOR phase of the TDD cycle and during implementation self-review.

The English summary is being prepared. Showing the original description.

DGouron/review-flow44Updated Oct 18, 2026

See all skills by DGouron

Report a problem with this skill