Skip to content
Skills Library
Programming · Writing

docs

/docs

Documentation generation. Triggers on /codeforge:docs. Reads actual code to produce README, API reference, architecture doc, or runbook. Never guesses.

Repository
codeforge ↗
Licence
MIT
Last repository change
26.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
2
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 26.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

Documentation generation. Triggers on /codeforge:docs. Reads actual code to produce README, API reference, architecture doc, or runbook. Never guesses.

Original author description

Documentation generation. Triggers on /codeforge:docs. Reads actual code to produce README, API reference, architecture doc, or runbook. Never guesses.

How it works

  1. Doc type
  2. README sections
  3. API reference (per function)
  4. Quality gates
Original SKILL.md headings · 34 lines, 161 words
SKILL.md preview
---
name: docs
description: Documentation generation. Triggers on /codeforge:docs. Reads actual code to produce README, API reference, architecture doc, or runbook. Never guesses.
allowed-tools: Read, Write, Grep, Glob, Bash(git log:*)
---

# codeforge:docs

## Doc type

| Trigger | Output |
|---------|--------|
| Blank or "readme" | README |
| Function/class path | API reference |
| "arch" | Architecture doc |
| "runbook" | Runbook |

## README sections

| Section | Rule |
|---------|------|
| Description | One line: what it does (not what it is) |
| Why | Problem solved (mandatory) |
| Quick start | Working in < 2 min, exact commands |
| Features | 3-5 bullets, no marketing words |
| Config | Table: variable / type / default / description |
| Contributing | How to add skill, agent, command |

## API reference (per function)

Signature with full types, behavior (what not how), params (name/type/required/desc), returns (type+example), errors (all codes), working example (runs as-is).

## Quality gates

- Every code block has language tag and actually runs
- No TODO placeholders
- Version-pin all install commands
- Verify every behavior before documenting it
Files in this package (2)
  • SKILL.md 1 KB
  • agents/openai.yaml 1 KB

Versions

RepositoryScoreLicence
This page · prashantxo/codeforge100MIT
tanstack/ai100MIT
mthines/agent-skills100MIT
lilly-logic-labs/lll-skills100MIT
kriscard/kriscard-claude-plugins100MIT
imgly/agent-skills100MIT
kriscard/Skills100MIT
The01Geek/prflow100MIT
grimoire-rs/grimoire100Apache-2.0

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

Downloads in the last 30 days: 0 · ranking

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

Similar skills

  • 100update-docs
    Use when a ticket requires documentation to reflect a change — a README, API reference, changelog, or runbook — or when an acceptance criterion says "document X". Invoke for "update the docs for the new endpoint", "add a changelog entry", or "the README is now wrong".
  • 100code-documentation
    Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and…
  • 100documentation
    Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
  • 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.
  • 100readme-generator-free
    Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository…
  • 100plan-docs-sync
    Plan-only audit of documentation against actual code behavior. Use when "docs drift", "sync docs with code", "audit documentation", "stale README", "onboarding docs broken", "phantom docs", or "docs out of date". Decisions/ADRs → docs-adr.

Feedback and reports

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