Skip to content
Skills Library
Programming · Writing

tl-docs-create

/tl-docs-create

Create documentation from scratch for codebases. Covers SSOT-driven generation, writing standards, and templates for README/AGENTS.md/CHANGELOG. Use when creating new docs or documenting an undocumented codebase.

Licence
MIT
Last repository change
20.10.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
24
Scripts
0
HTML comments
1
URLs in SKILL.md
9
Deprecation

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

Licence

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

What to check before installing
  • SKILL.md zawiera komentarze HTML (1). Nie widać ich w podglądzie Markdown, a model je czyta.

What it does and when to use it

Create documentation from scratch for codebases. Covers SSOT-driven generation, writing standards, and templates for README/AGENTS.md/CHANGELOG. Use when creating new docs or documenting an undocumented codebase.

Original author description

Create documentation from scratch for codebases. Covers SSOT-driven generation, writing standards, and templates for README/AGENTS.md/CHANGELOG. Use when creating new docs or documenting an undocumented codebase.

How it works

  1. When to Use
  2. Outcomes
  3. Configuration Discovery
  4. Phase 1: Assessment
  5. Phase 2: Doc Type Selection
  6. Phase 3: Standards
  7. Phase 4: Execution
  8. Phase 5: Verification
  9. Self-Documentation
  10. Documentation Rules
Original SKILL.md headings · 225 lines, 964 words
SKILL.md preview
---
name: tl-docs-create
description: Create documentation from scratch for codebases. Covers SSOT-driven generation, writing standards, and templates for README/AGENTS.md/CHANGELOG. Use when creating new docs or documenting an undocumented codebase.
license: MIT
metadata:
  version: "1.1"
  author: Todd Levy <toddlevy@gmail.com>
  homepage: https://github.com/toddlevy/tl-agent-skills
  quilted:
    - source: google-gemini/gemini-cli/docs-writer
      weight: 0.25
      description: 4-phase workflow, voice/tone rules, verification checklist
    - source: shpigford/skills/readme
      weight: 0.15
      description: Exploration-first, 3 purposes, absurd thoroughness
    - source: getsentry/skills/agents-md
      weight: 0.12
      description: AGENTS.md structure, brevity rules, file-scoped commands
    - source: softaworks/agent-toolkit/crafting-effective-readmes
      weight: 0.10
      description: Project type detection, audience analysis
    - source: itechmeat/llm-code/changelog
      weight: 0.08
      description: CHANGELOG.md template, Keep a Changelog format
    - source: patricio0312rev/skills/api-docs-generator
      weight: 0.08
      description: OpenAPI patterns, API doc templates
    - source: remotion-dev/remotion/writing-docs
      weight: 0.06
      description: Language brevity, API-per-page rule
    - source: plaited/development-skills/code-documentation
      weight: 0.05
      description: TSDoc patterns
    - source: aj-geddes/useful-ai-prompts/markdown-documentation
      weight: 0.05
      description: GFM syntax, do/don't list
    - source: local/jambase-docs
      weight: 0.04
      description: SSOT generation, hierarchical READMEs, source attribution
    - source: local/agents-md-create
      weight: 0.02
      description: Project type templates
  moment: implement
  surface:
    - repo
  output: artifact
  risk: safe
  posture: opinionated
  suite: tl-docs
  related:
    - tl-docs-audit
    - tl-docs-viewer-create
---

<!-- Copyright (c) 2026 Todd Levy. Licensed under MIT. SPDX-License-Identifier: MIT -->

# Documentation Creation

Create documentation from scratch for any codebase with SSOT-driven generation, writing standards, and templates.

## When to Use

- "create documentation"
- "generate README"
- "create AGENTS.md"
- "start CHANGELOG"
- "document this codebase"
- Starting a new project that needs docs
- Documenting an undocumented codebase
- Creating docs folder structure

For auditing existing docs, see `tl-docs-audit`.

## Outcomes

- **Artifact**: Documentation tree (README, AGENTS.md, CHANGELOG, docs/ folder, API reference)
- **Artifact**: Cursor rules for ongoing documentation maintenance (optional)
- **Decision**: Doc types needed based on project and audience

---

## Configuration Discovery

Before creating documentation, gather user intent through structured questions. See `references/configuration.md` for full question schemas.

### Question Flow Summary

1. **Light scan** — Check for existing `docs/`, `README.md`, `AGENTS.md`, `CHANGELOG.md`
2. **Existing docs?** — If found, suggest `tl-docs-audit` instead; otherwise proceed
3. **Audience** — Contributors / Users / Operators / Future self / Mixed
4. **Scope** — Minimal / Standard / Comprehensive / Absurdly thorough
5. **Doc Types** — README / AGENTS.md / CHANGELOG / docs/ / API reference / Rules
6. **Rules** — Create Cursor rules for doc maintenance? Yes / Pick / No

---

## Phase 1: Assessment

Explore the codebase before writing. Understand before documenting.

### Step 1: Deep Codebase Exploration

- Map directory organization and entry points
- Identify framework/language from `package.json`, `Gemfile`, `go.mod`, etc.
- Read deployment configs, CI configs, Docker files
- Check database type, migrations, seeds
- Note key dependencies and scripts

### Step 2: Detect Project Type

| Type | Indicators | Doc Focus |
|------|------------|-----------|
| **Monorepo** | `pnpm-workspace.yaml`, `nx.json`, multiple `package.json` | Per-package READMEs, root overview |
| **Frontend** | React/Vue/Angular deps, `vite.config`, `next.config` | Component docs, deployment |
| **Backend** | Express/Fastify/Rails, API routes | API reference, database schema |
| **Library** | `main`/`exports` in package.json, no app code | API docs, examples, changelog |
| **CLI** | `bin` field, commander/yargs deps | Usage, options, examples |

### Step 3: Identify Audience

Ask via AskQuestion if not clear from context. Affects tone, depth, and doc types.

---

## Phase 2: Doc Type Selection

Based on assessment and user answers, determine which artifacts to create.

| Doc Type | When Needed | Template |
|----------|-------------|----------|
| `README.md` | Always | `templates/readme-project.md` |
| `AGENTS.md` | AI-assisted development | `templates/agents-md.md` |
| `CHANGELOG.md` | Versioned releases | `templates/changelog.md` |
| `docs/` folder | Comprehensive scope | `templates/readme-root.md` |
| API reference | Backend/library projects | `templates/api-reference.md` |
| Docs Viewer UI | Admin interface needed | See `tl-docs-viewer` skill |

---

## Phase 3: Standards

Apply writing standards from `references/writing-standards.md`.

### Quick Reference

| Rule | Description |
|------|-------------|
| Address as "you" | Not "we" or passive voice |
| No Latin abbreviations | "for example" not "e.g." |
| Serial comma | Oxford comma always |
| Overview after headings | Every heading needs intro paragraph |
| Brevity | Developers don't read; extra words = info loss |
| No blame | "Input is invalid" not "You provided wrong input" |
| No assumptions | Avoid "simply" and "just" |

---

## Phase 4: Execution

Create or update documentation using templates from `references/templates/`.

### For Each Doc Type

1. Load appropriate template
2. Fill with codebase-specific content
3. Apply writing standards
4. Add source attribution where applicable
5. Create Cursor rules if user selected rule creation

### Source Attribution

For generated docs (scripts, env vars), add footer:
```markdown
---
_Source: `path/to/source-file.ts`_
```

### Last Updated

For docs with freshness tracking:
```markdown
> **Last Updated:** 2026-03-17
```

---

## Phase 5: Verification

Before completing, verify documentation quality.

### Checklist

- [ ] All selected doc types created
- [ ] Writing standards applied (run through `references/writing-standards.md`)
- [ ] Internal links validated (relative paths exist)
- [ ] No orphaned docs (all docs reachable from README or index)
- [ ] Last Updated dates current

### Validation Commands

If available, run:
- `pnpm lint` or project's lint command
- Link checker if configured
- `agentskills validate` for skill-specific validation

---

## Self-Documentation

Generate docs from code where possible. See `references/self-documentation.md`.

### Script Documentation

Parse script headers to generate docs:
- Usage, Options, Examples
- Environment Variables
- Prerequisites, Related
- Exit Codes, Troubleshooting

### Environment Variables

Generate tables from config:

| Variable | Service(s) | Description | Example |
|----------|------------|-------------|---------|
| `DATABASE_URL` | api | PostgreSQL connection | `postgresql://...` |

---

## Documentation Rules

Optionally create Cursor rules for ongoing maintenance. See `references/doc-rules.md`.

Available rules:
- `readme-sync.mdc` — Update README when features change
- `changelog-commits.mdc` — CHANGELOG from conventional commits
- `api-doc-sync.mdc` — Sync API docs with code changes
- `agents-md-maintain.mdc` — Keep AGENTS.md current
- `doc-style.mdc` — Enforce documentation style
- `last-updated.mdc` — Track Last Updated dates
- `link-check.mdc` — Validate internal doc links

---

## References

### Skill References

| File | Purpose |
|------|---------|
| `references/configuration.md` | AskQuestion flows and branching logic |
| `references/writing-standards.md` | Voice, tone, formatting rules |
| `references/self-documentation.md` | SSOT generation patterns |
| `references/doc-types.md` | README, AGENTS.md, CHANGELOG, API patterns |
| `references/docs-viewer.md` | Reference to `tl-docs-viewer-create` skill |
| `references/doc-rules.md` | Cursor rules for doc maintenance |

### First-Party Documentation

- [Keep a Changelog](https://keepachangelog.com/) — CHANGELOG format standard
- [MADR](https://adr.github.io/madr/) — Markdown Architectural Decision Records
- [Diátaxis](https://diataxis.fr/) — Documentation framework (tutorial/how-to/reference/explanation)
- [Conventional Commits](https://www.conventionalcommits.org/) — Commit message convention
- [Write the Docs](https://www.writethedocs.org/guide/) — Documentation community style guide

### Documentation Tools

- [TypeDoc](https://typedoc.org/) — TypeScript API documentation generator
- [JSDoc](https://jsdoc.app/) — JavaScript documentation generator
- [OpenAPI](https://www.openapis.org/) — REST API specification

---

## Related Skills

- [tl-docs-audit](../tl-docs-audit/SKILL.md) — Audit docs coverage, find gaps, generate sync reports
- [tl-docs-viewer-create](../tl-docs-viewer-create/SKILL.md) — React admin UI for browsing docs/ folder
Files in this package (24)
  • LICENSE 1 KB
  • README.md 3 KB
  • SKILL.md 9 KB
  • references/configuration.md 8 KB
  • references/doc-rules.md 10 KB
  • references/doc-types.md 8 KB
  • references/docs-viewer.md 5 KB
  • references/self-documentation.md 8 KB
  • references/writing-standards.md 6 KB
  • references/rules/agents-md-maintain.mdc 3 KB
  • references/rules/api-doc-sync.mdc 2 KB
  • references/rules/changelog-commits.mdc 2 KB
  • references/rules/doc-style.mdc 4 KB
  • references/rules/last-updated.mdc 2 KB
  • references/rules/link-check.mdc 3 KB
  • references/rules/readme-sync.mdc 2 KB
  • references/templates/agents-md.md 2 KB
  • references/templates/api-reference.md 3 KB
  • references/templates/changelog.md 3 KB
  • references/templates/env-vars.md 3 KB
  • references/templates/readme-project.md 4 KB
  • references/templates/readme-root.md 2 KB
  • references/templates/readme-section.md 2 KB
  • references/templates/script-doc.md 3 KB

Versions

The database has no other skills named tl-docs-create.

Database snapshot: 13.11.2026 · package version 3c684b050be0 (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

  • 96create-readme
    Use when generating or updating a project README.md or CHANGELOG.md.
  • 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…
  • 100code-documentation
    Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
  • 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…
  • 100project-docs
    This skill should be used when creating or updating this project's documentation — the changelog, issue logs, README, client guide, or flow/workflow docs — typically after implementing or changing code.
  • 95readme
    When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for he...

Feedback and reports

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