Skip to content
Skills Library
Programming · Automation

documentation-generation

/documentation-generation

Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files.

Licence
MIT
Last repository change
30.06.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
4
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 30.06.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files.

Original author description

Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files.

How it works

  1. Iron Law: NO DOC GENERATION WITHOUT READING THE PROJECT-SPECIFIC TEMPLATES FIRST
  2. Process
  3. When to Use
  4. References
  5. Error Handling
Original SKILL.md headings · 33 lines, 233 words
SKILL.md preview
---
name: documentation-generation
description: "Generates project documentation including READMEs, docstrings (JSDoc, JavaDoc, Python docstrings), OpenAPI prose, and CI/CD doc pipelines. Use when asked to generate docs, write docstrings, automate documentation, or create README files."
allowed-tools: Read, Grep, Glob, Bash, Write, Edit
metadata:
  triggers: README, docstring, documentation, API docs, JSDoc, JavaDoc, doc generation, documentation pipeline
  related-skills: openapi-spec-generation, changelog-generator, architecture-decision-records
  domain: workflow
  role: specialist
  scope: design
  output-format: document
last-reviewed: "2026-03-15"
---

## Iron Law: NO DOC GENERATION WITHOUT READING THE PROJECT-SPECIFIC TEMPLATES FIRST

Read the appropriate reference before writing any documentation.

## Process

1. **Detect stack** — Check for `pom.xml` (Java), `package.json` (NestJS/Angular), `pyproject.toml` (Python), `pubspec.yaml` (Flutter)
2. **Load template** — Read the matching section in `references/readme-templates.md`
3. **Apply docstring pattern** — Read `references/docstring-patterns.md` for the correct format per language
4. **Configure CI/CD** — Read `references/cicd-doc-pipeline.md` when setting up automated doc generation

## When to Use

- Creating or refreshing a project README
- Writing docstrings for public APIs (with `/doc-generate`)
- Setting up a CI/CD pipeline that auto-generates API docs on push
- Generating OpenAPI specs from code annotations (see `openapi-spec-generation` skill)
- Creating architecture diagrams (use `mermaid-expert` agent)

## References

| File | Content | Load When |
|------|---------|-----------|
| `references/readme-templates.md` | Stack-specific README templates for Java/Spring, NestJS, Python FastAPI, Flutter | Writing README for Java, NestJS, Python, or Flutter project |
| `references/docstring-patterns.md` | Javadoc, JSDoc, Python Google-style, Dart `///` patterns with examples | Writing Javadoc, JSDoc, Python docstrings, Dart doc comments |
| `references/cicd-doc-pipeline.md` | GitHub Actions workflow for auto-doc generation + Redocly + GitHub Pages | Setting up automated doc generation, GitHub Pages, Redocly |

## Error Handling

If project type cannot be auto-detected, ask the user to specify the stack before loading templates.
If README exists and appears current, report that and do not overwrite without explicit approval.
Files in this package (4)
  • SKILL.md 2 KB
  • references/cicd-doc-pipeline.md 5 KB
  • references/docstring-patterns.md 6 KB
  • references/readme-templates.md 5 KB

Versions

The database has no other skills named documentation-generation.

Database snapshot: 13.11.2026 · package version 6f716dcfe9d8 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 1 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100documentation
    Generate docstrings, JSDoc, API docs, and README updates that reflect current code. Use when: docs, docstring, JSDoc, README, API docs, document this, add documentation.
  • 100api-docs-generator
    Generates API documentation from code including OpenAPI specs, JSDoc, and Python docstrings. Use when documenting APIs, REST endpoints, or library functions.
  • 100doc-gen
    Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen.
  • 100code-documenter
    Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing…
  • 100code-documenter
    Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing…
  • 100code-documenter
    Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.