Documentation
Reusable agent skills for automated coding workflows across languages and frameworks.
npx -y skills add CodeByVibes/agents-extras --skill documentationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
3 things to look at
- 17 days oldThe repository was created 17 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Provides guidelines and templates for writing consistent, high-quality documentation. Use when the user asks to write, generate, update, or format documentation (such as a README, ADR, Changelog, or API reference) across any language or framework.
SKILL.md
2.4 KB, as published. Nobody here has run it
Documentation Skill
This skill provides comprehensive guidelines and templates for writing documentation.
Core Guidelines (Always Read)
Before starting any documentation task, ensure you review the core guidelines:
Validation Script
After generating or updating any Markdown documentation, you MUST run the validation script located in the scripts/ directory to ensure there are no formatting errors.
- Windows:
.\scripts\validate.ps1 <path_to_file.md> - Linux/Mac:
./scripts/validate.sh <path_to_file.md>
Context-Specific Guidelines
Depending on the task, you should read the relevant context-specific guidelines using your file reading tools.
Project Documentation
- Creating an ADR? Read ADR Guidelines and use the ADR Template.
- Writing an API Reference? Read API Guidelines and use the API Template.
- Updating the Changelog? Read Changelog Guidelines and use the Changelog Template.
- General README? Read Readme Guidelines and use the README Template.
Language-Specific Documentation
When documenting code for a specific language, read the corresponding guidelines:
Framework-Specific Documentation
When working with specific frameworks, read these guidelines:
Gives 0 of the 12 instructions most readme changelog skills give
Counted across 471 of the 478 authors here whose files we hold, read 2026-08-06
- follow the Keep a Changelog formatin 31 of 471, across 26 files
- omit empty sectionsin 21 of 471
- Run from the git repository rootin 20 of 471, across 7 files
- save output directly to CHANGELOG.mdin 20 of 471, across 7 files
- Group commits into logical categoriesin 19 of 471, across 6 files
- Review the generated changelog before publishingin 19 of 471, across 6 files
- Apply changelog guidelines and brand voicein 18 of 471, across 5 files
- Exclude internal commits like refactoring and testsin 18 of 471, across 5 files
- Specify date ranges for focused changelogsin 17 of 471, across 4 files
- Convert technical commits into customer languagein 17 of 471, across 4 files
- group commits by conventional commit typein 14 of 471
- insert new entry below unreleased sectionin 14 of 471
Said here and by no other author read
- read the core documentation guidelines before starting
- run the validation script after updating markdown
- read the relevant context-specific guidelines
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once.