PR Design Doc
OpenHands/OpenHands
For a non-trivial pull request, write a self-contained HTML design doc under the temporary .pr/ directory and link a visibility-appropriate preview in the PR description, so maintainers grasp the…
Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md…
Install Docs Writer
$ npx skills add strands-agents/box --skill docs-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install strands-agents/box docs-writer --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-writer .claude/skills/docs-writer && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .claude/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writerType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add strands-agents/box --skill docs-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install strands-agents/box docs-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/docs-writer .agents/skills/docs-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .agents/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add strands-agents/box --skill docs-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install strands-agents/box docs-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/docs-writer .cursor/skills/docs-writer && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .cursor/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/strands-agents/box.git --path .agents/skills/docs-writer--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add strands-agents/box --skill docs-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install strands-agents/box docs-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/docs-writer .gemini/skills/docs-writer && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .gemini/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install strands-agents/box docs-writerInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add strands-agents/box --skill docs-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/docs-writer .github/skills/docs-writer && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .github/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add strands-agents/box --skill docs-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install strands-agents/box docs-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/strands-agents/box.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/docs-writer .opencode/skills/docs-writer && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "docs-writer" agent skill from https://github.com/strands-agents/box/tree/main/.agents/skills/docs-writer into .opencode/skills/docs-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-writer", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
docs-writer- GitHub stars
- 110
- Token cost
- ~1.6k tokens
- SKILL.md length
- 896 words
- Files
- 1
- Skills in repo
- 10
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md…
- Works in 10 steps: Place and classify → Gather the facts → Sort the facts → …
- Asked to write a doc
- SKILL.md covers Inputs, Process, Output and What this skill doesn't do, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Docs Writer is an agent skill from strands-agents/box. Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md that serves a consumer. Use when asked to write a doc, draft a page, rewrite a page that failed audit, document a feature or a component, or write an architecture or security page. Not for docs/design/decisions.md (use kd), local specs (use spec), or research notes (use explore).
Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Architecture decision records. The repository describes itself as: Run AI agents in a sandbox that restricts what they can execute, read, write, and reach on the network. Box combines OS isolation with default-deny Dogwood policies and… The licence is Apache-2.0.
When your agent uses it
- Asked to write a doc
- Rewrite a page that failed audit
- Document a feature
- Write an architecture
Example prompts
- “/docs-writer”
Workflow steps
10 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 2c874ea. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are bash).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Docs Writer loads about 1.6k tokens when it runs. Until then it costs about 123 tokens; SKILL.md has 896 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from strands-agents/box at commit 2c874ea, republished under its Apache-2.0 licence (© strands-agents). 896 words, ~1,553 tokens.
Download SKILL.mdSave it as
.claude/skills/docs-writer/SKILL.md (or your agent's skills folder).- name
- docs-writer
- description
- Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md that serves a consumer. Use when asked to write a doc, draft a page, rewrite a page that failed audit, document a feature or a component, or write an architecture or security page. Not for docs/design/decisions.md (use kd), local specs (use spec), or research notes (use explore).
Documentation writer
Draft or rewrite one Box documentation page in the voice of
voice-guide.md.
Inputs
- Topic: what the page covers. Required.
- Content type: tutorial, how-to, reference, or explanation. Classify it in Step 1 if the user doesn't give it.
- Target file: the path in
docs/user/ordocs/design/, if known. - Existing content: the page to rewrite.
Process
Step 1: Place and classify
- Read
voice-guide.mdanddocs/design/terminology.md. - Ask the placement question: does the reader need this page to use Box, or to trust or change
Box? That picks
docs/user/ordocs/design/. - Classify the content type. A page in
docs/design/is an explanation. - Stop if the page belongs to another owner:
decisions.md(thekdskill),terminology.md, ortenets.md(only when the user asks). - Read the README of the guide, and each page the new page links to or replaces.
Step 2: Gather the facts
Read the code on current main before you write about it.
- For each claim you expect to make, find the code that implements it and the test that pins it.
- For a design page, find each relevant entry in
docs/design/decisions.mdand note its anchor. - For a user page, find the parser that owns each key, verb, or action.
- Note every place where the terminology lock disagrees with what the code, the binaries, or
decisions.mdcall something.
Write down what you can't find: it goes to Tier 3 of
claim-verification.md, not onto the page.
Step 3: Sort the facts
You'll have far more than the page needs. Write a fact sheet to .agents/drafts/<page>-facts.md
that puts each fact in one of three piles:
- This page. It's at the page's altitude and the reader needs it here.
- Another page. It belongs to a sibling topic. It gets one clause and a link at most.
- Nowhere. An implementation detail that no reader of either page needs.
Expect most facts to land outside "this page".
Step 4: Outline
Start from the skeleton for the subject in
page-templates.md. A page about several parts gets one
section per part. Read the outline for scope creep and for detail that belongs to another page.
Show the outline to the user before you draft when the page is new, or when the outline changes the structure of an existing page. Raise each terminology clash from Step 2 at the same time.
Step 5: Draft
- Each section opens with what the reader needs first (Layer 2).
- Use the register for the content type (Layer 3).
- Read each paragraph aloud as you go. Rewrite any sentence a person wouldn't say.
- User guide: describe what is, and explain why only when the reason changes the operator's action.
- Design guide: keep each claim within what its test pins, name no test, and link each decision by anchor.
- Examples are complete, realistic, and one concept per block, with the output below the command.
- Diagrams show the main path only.
Step 6: Verify
Follow claim-verification.md for each claim and each
example. Don't skip this step. Remove each claim you can't verify, and report it.
Step 7: Cut
Cut by altitude, not by a percentage. Look first for detail that belongs to another page, then for a list said twice, then for sentences that restate the one before. Keep what this page's reader needs. Most of the quality comes from this step.
Show full SKILL.md (344 more words)Show less
Step 8: Check
Run the mechanical check and clear or justify each hit:
.agents/skills/docs-reviewer/check-prose.sh <target-file>Compile each Mermaid block with mmdc.
Step 9: Review
Run the docs-reviewer skill on the draft in a fresh context. Fix its findings, then run it again
until the verdict is "Ship it".
Step 10: Link the page
Add one row for a new page to the README.md of its guide. Remove the page from the "still to
come" list in docs/design/README.md if it's there.
Output
- The page, written to the target file.
- A short note on the content type and each editorial choice.
- Each claim you left out because you couldn't verify it, with the symbol and the tier that failed.
- Open questions for the user: terminology, scope, and accuracy. When no user is in the loop (another agent ran this skill), this list replaces asking.
- Each
decisions.mdentry that the code contradicts. Report it, and don't edit it: thekdskill owns that file.
In rewrite mode, also report:
- Each claim in the original that current
maincontradicts, as its own list, so the author can fix the original even if they don't take the rewrite. - Whether the row for the page in its guide's
README.mdneeds new wording for the new outline.
What this skill doesn't do
- Commit, push, or open a pull request. Follow the commit flow in
AGENTS.mdwhen the user asks. - Write an entry in
decisions.md. That's thekdskill. - Add or change a term in the terminology lock without the user's approval.
- Change code to agree with a page.
Gotchas
- A design page isn't a decision entry. It explains how the parts fit together for a reader who wasn't there. Summarize a decision and link its anchor. Don't copy the argument.
- A command and its binary can have different names. Check what ships before you name one.
--all-featuresis required when you run a test to verify a claim. Without it, some suites are skipped and report success.- The first draft carries detail from other pages. Always.
© strands-agents, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/docs-writer of strands-agents/box.
Open the folder on GitHubat commit 2c874ea
Compare with similar skills
Docs Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Docs Writer this skillstrands-agents/box | 110 | — | ~1.6k | Automated safety check: Pass | Apache-2.0 | |
| PR Design DocOpenHands/OpenHands | 90k | — | ~2.4k | Automated safety check: Pass | MIT | |
| Cto AdvisorIbrahim-3d/orchestrator-supaconductor | 380 | 4 repos | ~2.4k | Automated safety check: Pass | MIT | |
| Improve Codebase Architectureywwynm/EverythingDone | 144 | 15 repos | ~1.3k | Automated safety check: Pass | GPL-3.0 | |
| Domain Modelingbrim-borium/spotify_sdk | 166 | 5 repos | ~806 | Automated safety check: Pass | Apache-2.0 | |
| Design Doc MermaidSpillwaveSolutions/design-doc-mermaid | 175 | 1 repos | ~5.6k | Automated safety check: Pass | None |
Similar skills
Cto Advisor
Ibrahim-3d/orchestrator-supaconductor
Technical leadership guidance for engineering teams, architecture decisions, and technology strategy.
Improve Codebase Architecture
ywwynm/EverythingDone
Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/.
Domain Modeling
brim-borium/spotify_sdk
Build and sharpen a project's domain model. An agent skill from brim-borium/spotify_sdk.
Design Doc Mermaid
SpillwaveSolutions/design-doc-mermaid
Create Mermaid diagrams (flowchart, sequence, class, ER, state, C4, architecture) from text or source code.
Learning Opportunities
DrCatHicks/learning-opportunities
Facilitates deliberate skill development during AI-assisted coding.
More from strands-agents/box
All 10 skills in this repoAuthoring Box Policy
strands-agents/box
Author or edit a Strands Box policy (policy.dw) — turn an operator's natural-language allow/deny intent into a validated Dogwood policy over the box's fixed action vocabulary, including when…
Debug Os Failure On GitHub
strands-agents/box
Debug a CI failure on an OS you are not on (you are on Linux, it fails on macos-latest, or the reverse) without opening a pull request per attempt.
Docs Planner
strands-agents/box
Find the gaps in the Box documentation and produce a prioritized backlog for docs/user/ and docs/design/.
Kd
strands-agents/box
Deep-dive a SINGLE key decision. An agent skill from strands-agents/box.
Spec
strands-agents/box
Walk through spec-driven development, design then requirements, producing a local .spec.md and .requirements.md for one feature.
Docs Audit
strands-agents/box
Assess an existing Box documentation page (docs/user/, docs/design/, or a crate README.md) for accuracy against the code and its tests, placement, and voice, and recommend what to fix.
Related
Categories
Questions about Docs Writer
What does Docs Writer do?
Draft or rewrite a Box documentation page in docs/user/ (tutorial, how-to, or reference for an operator) or docs/design/ (explanation for a security evaluator or a contributor), or a crate README.md…. Docs Writer is an agent skill from strands-agents/box.md that serves a consumer.
When should I use Docs Writer?
Docs Writer fits situations like: asked to write a doc; rewrite a page that failed audit; document a feature; write an architecture.
How do I install Docs Writer in Claude Code?
Run `npx skills add strands-agents/box --skill docs-writer -a claude-code`. Or copy the skill folder (.agents/skills/docs-writer in strands-agents/box) into .claude/skills/docs-writer in your project. Claude Code loads it when a task matches its description.
How do I install Docs Writer in Codex?
Run `npx skills add strands-agents/box --skill docs-writer -a codex`. Or copy the skill folder (.agents/skills/docs-writer in strands-agents/box) into .agents/skills/docs-writer in your project. Codex loads it when a task matches its description.
Can I use Docs Writer in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add strands-agents/box --skill docs-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-writer, .gemini/skills/docs-writer, .github/skills/docs-writer and .opencode/skills/docs-writer in your project.
What does Docs Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: Docs Writer is instructions for the agent only.
Does Docs Writer access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Docs Writer safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Docs Writer use?
Docs Writer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Docs Writer use?
About 1.6k tokens (SKILL.md is roughly 6.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Docs Writer?
Skills that share tags, products or a category with Docs Writer: PR Design Doc (OpenHands/OpenHands, 90k stars), Cto Advisor (Ibrahim-3d/orchestrator-supaconductor, 380 stars), Improve Codebase Architecture (ywwynm/EverythingDone, 144 stars) and Domain Modeling (brim-borium/spotify_sdk, 166 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Docs Writer?
strands-agents (a GitHub organization) maintains it in strands-agents/box, which has 110 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on October 8, 2026.
Source: strands-agents/box on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.