tl-docs-create（tl 文档创建）

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

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.

Phase 3: Standards

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

Quick Reference

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:

---
_Source: `path/to/source-file.ts`_

Last Updated

For docs with freshness tracking:

> **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:

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

First-Party Documentation

• Keep a Changelog — CHANGELOG format standard
• MADR — Markdown Architectural Decision Records
• Diátaxis — Documentation framework (tutorial/how-to/reference/explanation)
• Conventional Commits — Commit message convention
• Write the Docs — Documentation community style guide

Documentation Tools

• TypeDoc — TypeScript API documentation generator
• JSDoc — JavaScript documentation generator
• OpenAPI — REST API specification

Related Skills

• tl-docs-audit — Audit docs coverage, find gaps, generate sync reports
• tl-docs-viewer-create — React admin UI for browsing docs/ folder