About docs
A repository documentation skill for developers maintaining Markdown docs and API docstrings. It defines conventions for keeping the documentation index current and documenting new features.
Key features
- 01Update docs/index.md when docs change
- 02Use Google-style docstrings
- 03Document new features in docs/
- 04Skip documentation for bug fixes and CI changes
Use cases
- 01Add or rename a Markdown document
- 02Document a new feature
- 03Choose between docstrings and code comments
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/docsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
BENCHMARK.mdskill-card.mdskill.oms.sigevals/evals.jsonDetails
From the project READMEDocumentation Conventions
Keep docs/index.md Up to Date
When a new markdown doc is added under docs/**/*.md or a markdown file is renamed, ensure that @docs/index.md is updated and the document appears in the most appropriate section.
Docstring Format
Use Google style docstrings for classes and functions. These are parseable by Sphinx.
For interfaces that may be used outside a file, prefer docstrings over comments. Comments should be reserved for code within a function or interfaces local to a file.
Document New Features
When a new feature is added, update or create documentation in the docs/ directory that most closely matches the feature. Look at existing docs to find the best fit — if none exists, create a new doc and add it to @docs/index.md.
Documentation changes are not required for bug fixes or CI-related changes.