llm-doc-writer
Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
Best use case
llm-doc-writer is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "llm-doc-writer" skill to help with this workflow task. Context: Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/llm-doc-writer/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How llm-doc-writer Compares
| Feature / Agent | llm-doc-writer | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Write token-efficient documentation for LLM context. Use when creating CLAUDE.md, README, technical docs, agent instructions, or any documentation consumed by AI assistants.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
Best AI Skills for ChatGPT
Find the best AI skills to adapt into ChatGPT workflows for research, writing, summarization, planning, and repeatable assistant tasks.
Best AI Skills for Claude
Explore the best AI skills for Claude and Claude Code across coding, research, workflow automation, documentation, and agent operations.
SKILL.md Source
# LLM-Optimized Documentation
## Core Principles
| Principle | Rule |
|-----------|------|
| **Density** | Max info, min tokens |
| **Format** | Tables > prose, bullets > paragraphs |
| **No fluff** | Ban filler words (see list below) |
| **Show don't tell** | Code examples > explanations |
| **Progressive disclosure** | TOC + separate files for details |
## Banned Patterns
```
# Filler words - NEVER use
simplement, il suffit de, en fait, basically, just, simply,
it's important to note, as mentioned, obviously, of course,
please note that, keep in mind, remember that
# Redundant structures - NEVER use
"This file contains..." (obvious from filename)
"In this section we will..." (just do it)
"The following example shows..." (just show it)
```
## Format Rules
### Tables over Prose
```markdown
# BAD - 45 tokens
The system supports three modes: development mode which
enables hot reload, production mode which optimizes for
performance, and test mode which mocks external services.
# GOOD - 20 tokens
| Mode | Behavior |
|------|----------|
| dev | Hot reload |
| prod | Optimized |
| test | Mocked services |
```
### Bullets over Paragraphs
```markdown
# BAD - Narrative
To run the project, first ensure Node.js is installed,
then install dependencies with npm install, and finally
start the dev server with npm run dev.
# GOOD - Scannable
## Run
1. Requires: Node.js 18+
2. `npm install`
3. `npm run dev`
```
### Code over Explanation
```markdown
# BAD - Explaining
To create a new user, call the createUser function
with an object containing name and email properties.
# GOOD - Showing
```ts
createUser({ name: "Jo", email: "jo@x.com" })
```
```
## Structure Template
For CLAUDE.md / agent docs:
```markdown
# Project Name
## Stack
- Frontend: React/Vite
- Backend: FastAPI
- DB: PostgreSQL
## Commands
| Action | Command |
|--------|---------|
| Dev | `npm run dev` |
| Test | `npm test` |
| Build | `npm run build` |
## Architecture
[Brief description, link to detailed docs if needed]
## Conventions
- [Rule 1]
- [Rule 2]
```
## Progressive Disclosure
For long docs (>200 lines):
```markdown
# Main Doc
## Quick Reference
[Essential info here]
## Details
See [ARCHITECTURE.md](ARCHITECTURE.md)
See [API.md](API.md)
```
## Self-Check
Before finalizing, verify:
- [ ] No filler words?
- [ ] Tables used where possible?
- [ ] Bullet points, not paragraphs?
- [ ] Examples over explanations?
- [ ] < 500 lines (or split)?
- [ ] No redundant info?
## Examples
See [patterns.md](patterns.md) for before/after examples.Related Skills
prd-doc-writer
Write and iteratively refine PRD/需求文档 with a story-driven structure and strict staged confirmations (journey map alignment, per-story single-point confirmation, final generation gate). Use when the user asks to 梳理/撰写/完善 PRD、需求文档、用户故事、验收标准，并希望用 ASCII 线框图与 Mermaid（流程图/状态图/时序图）来减少歧义、共同完成文档。
svelte-code-writer
CLI tools for Svelte 5 documentation lookup and code analysis. MUST be used whenever creating, editing or analyzing any Svelte component (.svelte) or Svelte module (.svelte.ts/.svelte.js). If possible, this skill should be executed within the svelte-file-editor agent for optimal results.
writer
Document creation, format conversion (ODT/DOCX/PDF), mail merge, and automation with LibreOffice Writer.
wiki-page-writer
Generates rich technical documentation pages with dark-mode Mermaid diagrams, source code citations, and first-principles depth. Use when writing documentation, generating wiki pages, creating technical deep-dives, or documenting specific components or systems.
seo-content-writer
Writes SEO-optimized content based on provided keywords and topic briefs. Creates engaging, comprehensive content following best practices. Use PROACTIVELY for content creation tasks.
blog-writer
Write and add new blog posts for this Next.js site by matching the existing BlogPost structure in `src/lib/blog-data.ts`. Use when asked to draft a new blog article, update blog content, or produce SEO metadata/slug/image details for a new post.
pr-description-writer
Generates comprehensive, reviewer-friendly PR descriptions with visual diagrams, summary tables, collapsible sections, and structured test plans. Optimized for readability without sacrificing detail.
code-review-digest-writer
Generates weekly code-review digest docs from PR review comments for any GitHub repository. If present, follows project-specific docs/review-digests/AGENTS.md guidelines. Use this to turn a date-bounded set of PR reviews into a structured markdown “newsletter” that captures themes, repeated issues, and concrete takeaways.
libreoffice-writer
Use when creating, editing, formatting, exporting, or extracting LibreOffice Writer (.odt) documents via UNO, including session-based edits, structured text targets, tables, images, lists, patch workflows, and snapshots.
skill-writer
Guide users through creating Agent Skills for Claude Code. Use when the user wants to create, write, author, or design a new Skill, or needs help with SKILL.md files, frontmatter, or skill structure.
content-research-writer
Assists in writing high-quality content by conducting research, adding citations, improving hooks, iterating on outlines, and providing real-time feedback on each section. Transforms your writing process from solo effort to collaborative partnership.
documentation-writer
Expert technical writer for Logseq Template Graph project. Generates comprehensive, accurate, and well-structured documentation for modules, features, guides, and APIs. Activates when asked to "write docs", "document this", "create README", "update documentation", or similar requests. Analyzes code/templates to extract information and writes clear, user-focused documentation following project style.