Skills Guide

Feature documentation generation

VerifiedSafe

Generates or updates documentation for the current feature, linking it to related documents and ensuring the main README is up to date. Helps maintain consistent, well-connected project documentation when adding new features.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude Code
#documentation#feature-docs#readme-update#doc-linking#project-docs

Recommended for

Claude CodeAuto documentation

Automated summary

Generates or updates documentation for a feature being developed, ensuring cross-linking and updating the main README.

Strengths

  • Automates creation of consistent, structured Markdown documentation.
  • Identifies and updates related documents, avoiding orphaned docs.
  • Integrates with Git to extract feature context and changes.
  • Generates a clear report of modifications made.

Limitations

  • Depends on a predefined documentation directory structure (e.g., docs/).
  • May not handle very large or unconventional project layouts without customization.
  • Generated examples may require manual verification for correctness.
When to use it

When adding a new feature or making significant changes that require documentation to keep the project up to date.

When not to use it

When only minor changes are made that do not warrant full documentation updates, or when the project explicitly discourages automated documentation.

Security analysis

Safe
Quality score90/100

The skill performs only documentation generation and updating tasks using standard tools (git, file read/write) with no destructive commands, exfiltration, or obfuscation.

No concerns found

How this analysis is made

Examples

Generate documentation for a new authentication feature
Generate documentation for the user authentication feature I just implemented. Use the standard docs directory and update the README if needed.
Update documentation after refactoring a module
I've refactored the payment processing module. Please update its documentation and check if any related documents need to be linked.
Add documentation for a new API endpoint
Document the new /api/v2/orders endpoint. Ensure the README and related docs are updated and linked.

name: doc:update description: Crées la documentation pour la fonctionnalité en cours. Mets à jour le readme global du projet si nécessaire. Lie les documents entre eux pour ne pas avoir de documentation orpheline. La documentation est générée dans les répertoire de documentation du projet. model: sonnet allowed-tools: [Bash, Read, Write, Edit, Glob, Grep] version: 1.0.0 license: MIT

Documentation de fonctionnalité

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

Génère ou met à jour la documentation pour la fonctionnalité en cours de développement, en s'assurant que tous les documents sont liés et que le README principal est à jour.

Purpose

Maintenir une documentation cohérente, à jour et bien interconnectée pour le projet.

Variables

  • CURRENT_BRANCH: Branche Git en cours
  • DOC_DIR: Répertoire de documentation du projet (détection automatique)
  • README_PATH: Chemin vers le README principal du projet
  • FEATURE_NAME: Nom de la fonctionnalité extraite de la branche et des modifications

Relevant Files

  • README.md - Documentation principale du projet
  • docs/ - Répertoire de documentation standard
  • Fichiers source de la fonctionnalité
  • Fichiers de tests associés

Workflow

1. Analyse du contexte

  • Identifie la branche Git en cours (git branch --show-current)
  • Analyse les modifications de la branche :
    • Fichiers modifiés (git status)
    • Diff par rapport à main/master (git diff)
    • Commits de la branche (git log)
  • Extrait le nom de la fonctionnalité depuis :
    • Le nom de la branche (ex: feature/user-auth → User Authentication)
    • Les commits de la branche
    • Les prompts récents de la session
  • Détermine le répertoire de documentation :
    • Cherche docs/, documentation/, ou équivalent
    • Crée le répertoire si nécessaire
  • Identifie les informations clés :
    • Fichiers principaux modifiés
    • Tests associés
    • Dépendances ajoutées/modifiées

2. Génération de la documentation

  • Crée ou met à jour le fichier de documentation :
    • Titre et description claire
    • Utilisation et exemples
    • Architecture et composants
    • Configuration nécessaire
    • Tests et validation
    • Limitations et notes
  • Format Markdown structuré avec :
    • Table des matières si nécessaire
    • Blocs de code avec syntaxe
    • Liens vers fichiers sources
    • Exemples d'utilisation concrets

3. Mise à jour du README principal

  • Vérifie si la fonctionnalité doit être mentionnée dans le README
  • Ajoute ou met à jour la section appropriée :
    • Fonctionnalités principales
    • Structure du projet
    • Documentation disponible
  • Maintient la cohérence du format existant
  • Préserve l'ordre et la hiérarchie

4. Liaison des documents

  • Identifie les documents connexes :
    • Documentation de fonctionnalités liées
    • Guides d'architecture
    • Tutoriels
    • ADRs (Architecture Decision Records)
  • Ajoute des liens bidirectionnels :
    • Depuis le nouveau document vers les connexes
    • Depuis les connexes vers le nouveau document
  • Vérifie l'absence de liens cassés
  • Crée un index si nécessaire pour les projets volumineux

5. Validation et rapport

  • Vérifie la qualité de la documentation :
    • Tous les exemples sont fonctionnels
    • Les liens sont valides
    • Le formatage Markdown est correct
    • Pas de typos évidentes
  • Génère un rapport de ce qui a été créé/modifié

Report

Affiche un résumé structuré :

Documentation générée :
- Fonctionnalité : [NOM]
- Fichier créé/modifié : [CHEMIN]
- Taille : [LIGNES] lignes

Modifications README :
- Section modifiée : [SECTION]
- Ajouts : [DESCRIPTION]

Liens créés :
- [DOC1] ↔ [DOC2]
- [DOC3] ↔ [DOC4]

Documents liés :
- [LISTE DES DOCS CONNEXES]

Best Practices

  • Documentation focalisée sur l'utilisation, pas l'implémentation
  • Exemples concrets et testés
  • Langage clair et concis (style bullet points)
  • Liens relatifs pour la portabilité
  • Pas de duplication entre README et docs détaillées
  • README = vue d'ensemble, docs/ = détails
  • Maintenir la cohérence du ton et du format

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/feature-documentation-generation-mm78nnw9/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/feature-documentation-generation-mm78nnw9' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/feature-documentation-generation-mm78nnw9/download' --output '.skill-downloads/feature-documentation-generation-mm78nnw9/SKILL.md.part' && mv '.skill-downloads/feature-documentation-generation-mm78nnw9/SKILL.md.part' '.skill-downloads/feature-documentation-generation-mm78nnw9/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

This file does not provide a usable name/description header for this native procedure. It remains available to download and inspect; use the manual method below.

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/feature-documentation-generation-mm78nnw9/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot