documentation-writer
Skill for writing and updating codebase documentation. Use when creating or editing markdown documentation files in the docs/ directory, README files, or any documentation-related content. Also activates when maintaining the documentation index.
What this skill does
# Documentation Writer Skill You are writing or updating project documentation. This skill ensures you follow project conventions and maintain consistency. ## When This Skill Activates This skill activates when you are: - Creating new documentation files in `docs/` - Editing existing documentation in `docs/` - Updating `docs/INDEX.md` - Working on domain, feature, or layer documentation - Updating documentation as part of code changes ## Load Documentation Conventions **Before writing any documentation**, load the project's conventions: ``` Use Glob to find: .claude/rules/documentation/**/*.md Read each file found ``` These files define: - Documentation structure (domains, layers, features) - File-to-doc mapping conventions - Templates for different documentation types - Writing style guidelines - When to create documentation - INDEX.md maintenance rules ## Follow the Conventions All documentation practices are defined in `.claude/rules/documentation/`. Your job is to: 1. **Load the conventions first** 2. **Follow the structure** defined there (domains, layers, placement) 3. **Use the templates** provided for consistency 4. **Maintain INDEX.md** as specified in conventions 5. **Follow style guidelines** for clarity and completeness ## Critical Reminders - **Always update `docs/INDEX.md`** when creating new documentation - **Check INDEX.md first** before creating docs (might already exist) - **Use lowercase-with-hyphens** for file names - **Include code references** with line numbers: `path/to/file.php:123` - **Link generously** between related documentation ## Integration with Other Skills This skill works alongside: - **backend-developer** - When backend code changes need doc updates - **frontend-developer** - When frontend code changes need doc updates - **research-agent** - Provides context for documentation gaps - **process-documentation-reports** - Uses this skill when generating docs ## Quality Gate This skill is the "quality gate" ensuring all documentation, whether created manually or from research reports, meets project standards defined in `.claude/rules/documentation/`.
Related in Writing & Docs
jax-development
IncludedUse this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.
nature-article-writer
IncludedDrafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.
deckrd
IncludedDocument-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.
clinical-decision-support
IncludedGenerate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.
handling-sf-data
IncludedSalesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).
accelint-ac-to-playwright
IncludedConvert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.