doc-coauthoring
Skill795 starsChanged 2 months agoMITView on GitHub
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
We split this skill into the rules it gives an agent
60 rules. 54 are common, 0 are distinctive, and 6 are very specific to this project.
54
Common
Most of the 163 edited versions we read keep these.
0
Distinctive
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Common: line 22
Reader Testing: Test the doc with a fresh Codex (no context) to catch blind spots before others read it
- Common: line 26
If user declines, work freeform.
- Common: line 34
Start by asking the user for meta-context about the document:
- Common: line 45
Ask if they have a template document to share
- Common: line 46
If they provide a link to a shared document, use the appropriate integration to fetch it
- Common: line 47
If they provide a file, read it
- Common: line 50
Use the appropriate integration to read the current state
- Common: line 51
Check for images without alt-text
- Common: line 52
If images exist without alt-text, explain that when others use Codex to understand the doc, Codex won't be able to see them.
- Common: line 78
If user mentions team channels or shared documents:
- Common: line 79
If integrations available: Inform them the content will be read now, then use the appropriate integration
- Common: line 80
If integrations not available: Explain lack of access.
- Common: line 82
If user mentions entities/projects that are unknown:
- Common: line 83
Ask if connected tools should be searched to learn more
- Common: line 84
Wait for user confirmation before searching
- Common: line 90
When user signals they've done their initial dump (or after substantial context provided), ask clarifying questions to ensure understanding:
- Common: line 100
Ask if there's any more context they want to provide at this stage, or if it's time to move on to drafting the document.
- Common: line 102
If user wants to add more, let them.
- Common: line 116
Start with whichever section has the most unknowns (usually the core decision/proposal), then work through the rest.
- Common: line 120
If the document structure is clear: Ask which section they'd like to start with.
- Common: line 121
Ask which section they'd like to start with.
- Common: line 125
If user doesn't know what sections they need: Based on the type of document and template, suggest 3-5 sections appropriate for the doc type.
- Common: line 128
Ask if this structure works, or if they want to adjust it.
- Common: line 132
Create the initial document structure with placeholder text for all sections.
- Very specific: line 135
Use create_file to create an artifact.
- Common: line 139
Create artifact with all section headers and brief placeholder text like "[To be written]" or "[Content here]".
- Very specific: line 144
Create a markdown file in the working directory.
- Common: line 148
Create file with all section headers and placeholder text.
- Common: line 172
Ask which points should be kept, removed, or combined.
- Very specific: line 188
Use str_replace to replace the placeholder text for this section with the actual drafted content.
- Common: line 193
After drafting, provide a link to the artifact.
- Common: line 195
Ask them to read through it and indicate what to change.
- Common: line 198
After drafting, confirm completion.
- Very specific: line 208
Use str_replace to make edits (never reprint the whole doc)
- Common: line 211
If user edits doc directly and asks to read it: mentally note the changes they made and keep them in mind for future sections (this shows …
- Common: line 217
After 3 consecutive iterations with no substantial changes, ask if anything can be removed without losing important information.
- Common: line 219
When section is done, confirm [SECTION NAME] is complete.
- Common: line 231
Read entire document and provide feedback.
- Common: line 240
Ask if ready to move to Reader Testing, or if they want to refine anything else.
- Common: line 244
Goal: Test the document with a fresh Codex (no context bleed) to verify it works for readers.
- Common: line 296
Ask what questions people might ask when trying to discover this document.
- Common: line 305
Ask Reader Codex the generated questions
- Common: line 312
Check if Reader Codex gives correct answers or misinterprets anything.
- Common: line 323
Ask what Reader Codex got wrong or struggled with.
- Common: line 331
When Reader Codex consistently answers questions correctly and doesn't surface new gaps or ambiguities, the doc is ready.
- Common: line 335
When Reader Testing passes: Announce the doc has passed Reader Codex testing.
- Common: line 340
Ask them to verify it achieves the impact they wanted
- Common: line 342
Ask if they want one more review, or if the work is done.
- Common: line 346
Consider linking this conversation in an appendix so readers can see how the doc was developed
- Common: line 347
Use appendices to provide depth without bloating the main doc
- Common: line 348
Update the doc as feedback is received from real readers
- Common: line 355
Don't try to "sell" the approach - just execute it
- Common: line 358
If user wants to skip a stage: Ask if they want to skip this and write freeform
- Common: line 359
If user seems frustrated: Acknowledge this is taking longer than expected.
- Common: line 360
Always give user agency to adjust the process
- Common: line 364
Don't let gaps accumulate - address them as they come up
- Very specific: line 367
Use create_file for drafting full sections
- Very specific: line 368
Use str_replace for all edits
- Common: line 370
Never use artifacts for brainstorming lists - that's just conversation
- Common: line 373
Don't rush through stages
“Common” is measured: kept by at least 6 in 10 of the 163 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Doc Co-Authoring Workflow
This skill provides a structured workflow for guiding users through collaborative document creation. Act as an active guide, walking users through three stages: Context Gathering, Refinement & Structure, and Reader Testing.
When to Offer This Workflow
Trigger conditions:
- User mentions writing documentation: "write a doc", "draft a proposal", "create a spec", "write up"
- User mentions specific doc types: "PRD", "design doc", "decision doc", "RFC"
- User seems to be starting a substantial writing task
Initial offer: Offer the user a structured workflow for co-authoring the document. Explain the three stages:
- Context Gathering: User provides all relevant context while Codex asks clarifying questions
- Refinement & Structure: Iteratively build each section through brainstorming and editing
- Reader Testing: Test the doc with a fresh Codex (no context) to catch blind spots before others read it
Explain that this approach helps ensure the doc works well when others read it (including when they paste it into Codex). Ask if they want to try this workflow or prefer to work freeform.
If user declines, work freeform. If user accepts, proceed to Stage 1.
Stage 1: Context Gathering
Goal: Close the gap between what the user knows and what Codex knows, enabling smart guidance later.
Initial Questions
Start by asking the user for meta-context about the document:
- What type of document is this? (e.g., technical spec, decision doc, proposal)
- Who's the primary audience?
- What's the desired impact when someone reads this?
- Is there a template or specific format to follow?
- Any other constraints or context to know?
Inform them they can answer in shorthand or dump information however works best for them.
If user provides a template or mentions a doc type:
- Ask if they have a template document to share
- If they provide a link to a shared document, use the appropriate integration to fetch it
- If they provide a file, read it
If user mentions editing an existing shared document:
- Use the appropriate integration to read the current state
- Check for images without alt-text
- If images exist without alt-text, explain that when others use Codex to understand the doc, Codex won't be able to see them. Ask if they want alt-text generated. If so, request they paste each image into chat for descriptive alt-text generation.
Info Dumping
Once initial questions are answered, encourage the user to dump all the context they have. Request information such as:
- Background on the project/problem
- Related team discussions or shared documents
- Why alternative solutions aren't being used
- Organizational context (team dynamics, past incidents, politics)
- Timeline pressures or constraints
- Technical architecture or dependencies
- Stakeholder concerns
Advise them not to worry about organizing it - just get it all out. Offer multiple ways to provide context:
- Info dump stream-of-consciousness
- Point to team channels or threads to read
- Link to shared documents
If integrations are available (e.g., Slack, Teams, Google Drive, SharePoint, or other MCP servers), mention that these can be used to pull in context directly.
If no integrations are detected and in Codex.ai or Codex app: Suggest they can enable connectors in their Codex settings to allow pulling context from messaging apps and document storage directly.
Inform them clarifying questions will be asked once they've done their initial dump.
During context gathering:
- If user mentions team channels or shared documents:
- If integrations available: Inform them the content will be read now, then use the appropriate integration
- If integrations not available: Explain lack of access. Suggest they enable connectors in Codex settings, or paste the relevant content directly.
- If user mentions entities/projects that are unknown:
- Ask if connected tools should be searched to learn more
- Wait for user confirmation before searching
- As user provides context, track what's being learned and what's still unclear
Asking clarifying questions:
When user signals they've done their initial dump (or after substantial context provided), ask clarifying questions to ensure understanding:
Generate 5-10 numbered questions based on gaps in the context.
Inform them they can use shorthand to answer (e.g., "1: yes, 2: see #channel, 3: no because backwards compat"), link to more docs, point to channels to read, or just keep info-dumping. Whatever's most efficient for them.
Exit condition: Sufficient context has been gathered when questions show understanding - when edge cases and trade-offs can be asked about without needing basics explained.
Transition: Ask if there's any more context they want to provide at this stage, or if it's time to move on to drafting the document.
If user wants to add more, let them. When ready, proceed to Stage 2.
Stage 2: Refinement & Structure
Goal: Build the document section by section through brainstorming, curation, and iterative refinement.
Instructions to user: Explain that the document will be built section by section. For each section:
- Clarifying questions will be asked about what to include
- 5-20 options will be brainstormed
- User will indicate what to keep/remove/combine
- The section will be drafted
- It will be refined through surgical edits
Start with whichever section has the most unknowns (usually the core decision/proposal), then work through the rest.
Section ordering:
If the document structure is clear: Ask which section they'd like to start with.
Suggest starting with whichever section has the most unknowns. For decision docs, that's usually the core proposal. For specs, it's typically the technical approach. Summary sections are best left for last.
If user doesn't know what sections they need: Based on the type of document and template, suggest 3-5 sections appropriate for the doc type.
Ask if this structure works, or if they want to adjust it.
Once structure is agreed:
Create the initial document structure with placeholder text for all sections.
If access to artifacts is available:
Use create_file to create an artifact. This gives both Codex and the user a scaffold to work from.
Inform them that the initial structure with placeholders for all sections will be created.
Create artifact with all section headers and brief placeholder text like "[To be written]" or "[Content here]".
Provide the scaffold link and indicate it's time to fill in each section.
If no access to artifacts:
Create a markdown file in the working directory. Name it appropriately (e.g., decision-doc.md, technical-spec.md).
Inform them that the initial structure with placeholders for all sections will be created.
Create file with all section headers and placeholder text.
Confirm the filename has been created and indicate it's time to fill in each section.
For each section:
Step 1: Clarifying Questions
Announce work will begin on the [SECTION NAME] section. Ask 5-10 clarifying questions about what should be included:
Generate 5-10 specific questions based on context and section purpose.
Inform them they can answer in shorthand or just indicate what's important to cover.
Step 2: Brainstorming
For the [SECTION NAME] section, brainstorm [5-20] things that might be included, depending on the section's complexity. Look for:
- Context shared that might have been forgotten
- Angles or considerations not yet mentioned
Generate 5-20 numbered options based on section complexity. At the end, offer to brainstorm more if they want additional options.
Step 3: Curation
Ask which points should be kept, removed, or combined. Request brief justifications to help learn priorities for the next sections.
Provide examples:
- "Keep 1,4,7,9"
- "Remove 3 (duplicates 1)"
- "Remove 6 (audience already knows this)"
- "Combine 11 and 12"
If user gives freeform feedback (e.g., "looks good" or "I like most of it but...") instead of numbered selections, extract their preferences and proceed. Parse what they want kept/removed/changed and apply it.
Step 4: Gap Check
Based on what they've selected, ask if there's anything important missing for the [SECTION NAME] section.
Step 5: Drafting
Use str_replace to replace the placeholder text for this section with the actual drafted content.
Announce the [SECTION NAME] section will be drafted now based on what they've selected.
If using artifacts: After drafting, provide a link to the artifact.
Ask them to read through it and indicate what to change. Note that being specific helps learning for the next sections.
If using a file (no artifacts): After drafting, confirm completion.
Inform them the [SECTION NAME] section has been drafted in [filename]. Ask them to read through it and indicate what to change. Note that being specific helps learning for the next sections.
Key instruction for user (include when drafting the first section): Provide a note: Instead of editing the doc directly, ask them to indicate what to change. This helps learning of their style for future sections. For example: "Remove the X bullet - already covered by Y" or "Make the third paragraph more concise".
Step 6: Iterative Refinement
As user provides feedback:
- Use
str_replaceto make edits (never reprint the whole doc) - If using artifacts: Provide link to artifact after each edit
- If using files: Just confirm edits are complete
- If user edits doc directly and asks to read it: mentally note the changes they made and keep them in mind for future sections (this shows their preferences)
Continue iterating until user is satisfied with the section.
Quality Checking
After 3 consecutive iterations with no substantial changes, ask if anything can be removed without losing important information.
When section is done, confirm [SECTION NAME] is complete. Ask if ready to move to the next section.
Repeat for all sections.
Near Completion
As approaching completion (80%+ of sections done), announce intention to re-read the entire document and check for:
- Flow and consistency across sections
- Redundancy or contradictions
- Anything that feels like "slop" or generic filler
- Whether every sentence carries weight
Read entire document and provide feedback.
When all sections are drafted and refined: Announce all sections are drafted. Indicate intention to review the complete document one more time.
Review for overall coherence, flow, completeness.
Provide any final suggestions.
Ask if ready to move to Reader Testing, or if they want to refine anything else.
Stage 3: Reader Testing
Goal: Test the document with a fresh Codex (no context bleed) to verify it works for readers.
Instructions to user: Explain that testing will now occur to see if the document actually works for readers. This catches blind spots - things that make sense to the authors but might confuse others.
Testing Approach
If access to sub-agents is available (e.g., in Codex):
Perform the testing directly without user involvement.
Step 1: Predict Reader Questions
Announce intention to predict what questions readers might ask when trying to discover this document.
Generate 5-10 questions that readers would realistically ask.
Step 2: Test with Sub-Agent
Announce that these questions will be tested with a fresh Codex instance (no context from this conversation).
For each question, invoke a sub-agent with just the document content and the question.
Summarize what Reader Codex got right/wrong for each question.
Step 3: Run Additional Checks
Announce additional checks will be performed.
Invoke sub-agent to check for ambiguity, false assumptions, contradictions.
Summarize any issues found.
Step 4: Report and Fix
If issues found: Report that Reader Codex struggled with specific issues.
List the specific issues.
Indicate intention to fix these gaps.
Loop back to refinement for problematic sections.
If no access to sub-agents (e.g., Codex.ai web interface):
The user will need to do the testing manually.
Step 1: Predict Reader Questions
Ask what questions people might ask when trying to discover this document. What would they type into Codex.ai?
Generate 5-10 questions that readers would realistically ask.
Step 2: Setup Testing
Provide testing instructions:
- Open a fresh Codex conversation: https://Codex.ai
- Paste or share the document content (if using a shared doc platform with connectors enabled, provide the link)
- Ask Reader Codex the generated questions
For each question, instruct Reader Codex to provide:
- The answer
- Whether anything was ambiguous or unclear
- What knowledge/context the doc assumes is already known
Check if Reader Codex gives correct answers or misinterprets anything.
Step 3: Additional Checks
Also ask Reader Codex:
- "What in this doc might be ambiguous or unclear to readers?"
- "What knowledge or context does this doc assume readers already have?"
- "Are there any internal contradictions or inconsistencies?"
Step 4: Iterate Based on Results
Ask what Reader Codex got wrong or struggled with. Indicate intention to fix those gaps.
Loop back to refinement for any problematic sections.
Exit Condition (Both Approaches)
When Reader Codex consistently answers questions correctly and doesn't surface new gaps or ambiguities, the doc is ready.
Final Review
When Reader Testing passes: Announce the doc has passed Reader Codex testing. Before completion:
- Recommend they do a final read-through themselves - they own this document and are responsible for its quality
- Suggest double-checking any facts, links, or technical details
- Ask them to verify it achieves the impact they wanted
Ask if they want one more review, or if the work is done.
If user wants final review, provide it. Otherwise: Announce document completion. Provide a few final tips:
- Consider linking this conversation in an appendix so readers can see how the doc was developed
- Use appendices to provide depth without bloating the main doc
- Update the doc as feedback is received from real readers
Tips for Effective Guidance
Tone:
- Be direct and procedural
- Explain rationale briefly when it affects user behavior
- Don't try to "sell" the approach - just execute it
Handling Deviations:
- If user wants to skip a stage: Ask if they want to skip this and write freeform
- If user seems frustrated: Acknowledge this is taking longer than expected. Suggest ways to move faster
- Always give user agency to adjust the process
Context Management:
- Throughout, if context is missing on something mentioned, proactively ask
- Don't let gaps accumulate - address them as they come up
Artifact Management:
- Use
create_filefor drafting full sections - Use
str_replacefor all edits - Provide artifact link after every change
- Never use artifacts for brainstorming lists - that's just conversation
Quality over Speed:
- Don't rush through stages
- Each iteration should make meaningful improvements
- The goal is a document that actually works for readers
Other versions174 projects use a version of this.
Word for word · 2
- opencue/cuecards★ 6100% same
- lichtungnitro/bookshelf★ 3100% same
Edited · 161
- anthropics/skills★ 186k95% same
- Galaxy-Dawn/claude-scholar★ 5.9k88% same
- moonrepo/moon★ 4.2k95% same
- ChenglinPoly/infiAgent★ 1.2k95% same
- polyuiislab/infiAgent★ 1.2k95% same
- getsentry/skills★ 1.1k94% same
- JetBrains/skills★ 38694% same
- zephyrwang6/myskill★ 33912% same
- xuzeyu91/WebCode★ 27895% same
- cohen-liel/hivemind★ 10895% same
151 more not listed
Wrote their own version · 11
- linxuan-sys/opencode-skills-chinese★ 200same name
- Immortalqx/my_codex_skills★ 54same name
- MarcelLeon/skills-zh★ 42same name
- xopcai/xopc★ 40same name
- mia-cx/skills★ 4same name
- CODE-SAURABH/OpenSkills★ 2same name
- adrianotomasoni/skills★ 1same name
- InsightStudio-2026/agent-assets★ 1same name
- manastalukdar/ai-devstudio★ 1same name
- walkingjohnny/ai-workbench★ 1same name
1 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
Used alongsideProjects with it also use context7-efficient, fetch-library-docs and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
hfzarslanSkillcontext7-efficient
Token-efficient library documentation fetcher using Context7 MCP with 86.8% token savings through intelligent shell pipeline filtering. Fetches code examples, API references, and best practices for JavaScript, Python, Go, Rust, and other libraries. Use when users ask about library documentation, need code examples, want API usage patterns, are learning a new framework, need syntax reference, or troubleshooting with library-specific information. Triggers include questions like "Show me React hooks", "How do I use Prisma", "What's the Next.js routing syntax", or any request for library/framework documentation.
Also in 5 projects that use this
Rehan-Ul-HaqSkillfetch-library-docs
Fetches official documentation for external libraries and frameworks (React, Next.js, Prisma, FastAPI, Express, Tailwind, MongoDB, etc.) with 60-90% token savings via content-type filtering. Use this skill when implementing features using library APIs, debugging library-specific errors, troubleshooting configuration issues, installing or setting up frameworks, integrating third-party packages, upgrading between library versions, or looking up correct API patterns and best practices. Triggers automatically during coding work - fetch docs before writing library code to get correct patterns, not after guessing wrong.
Also in 4 projects that use this
AbdullahMalik17Skillconfiguring-dapr-pubsub
Configures Dapr pub/sub components for event-driven microservices with Kafka or Redis. Use when wiring agent-to-agent communication, setting up event subscriptions, or integrating Dapr sidecars. Covers component configuration, subscription patterns, publishing events, and Kubernetes deployment. NOT when using direct Kafka clients or non-Dapr messaging patterns.
Also in 3 projects that use this
AbdullahMalik17Skilldeploying-cloud-k8s
Deploys applications to cloud Kubernetes (AKS/GKE/DOKS) with CI/CD pipelines. Use when deploying to production, setting up GitHub Actions, troubleshooting deployments. Covers build-time vs runtime vars, architecture matching, and battle-tested debugging.
Also in 3 projects that use this
AnthropicSkillacademy-guide
Stop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.
Also in 4 projects that use this
AnthropicSkillweb-artifacts-builder
Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
Also in 69 projects that use this
- +5 more from AbdullahMalik17
- +1 more from anthropics
In this repository39 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .agents/skills/vercel-react-best-practices/AGENTS.mdAGENTS.md
- .claude/skills/vercel-react-best-practices/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- banner-designSkill
- brandSkill
- component-docSkill
- component-refactoringSkill
- designSkill
- design-systemSkill
- design-taste-frontendSkill
- feature-devSkill
- frontend-code-reviewSkill
- frontend-designSkill
- frontend-testingSkill
- migrate-nativewind-to-uniwindSkill
- migrate-oxfmtSkill
- migrate-oxlintSkill
- native-component-docSkill
- senior-frontendSkill
- skill-creatorSkill
- skyroc-admin-prd-prototypeSkill
- slidesSkill
- ui-stylingSkill
- ui-ux-pro-maxSkill
- uniwindSkill
- vercel-react-best-practicesSkill
- component-docSkill
- component-refactoringSkill
- doc-coauthoringSkill
- feature-devSkill
- frontend-code-reviewSkill
- frontend-designSkill
- frontend-testingSkill
- native-component-docSkill
- senior-frontendSkill
- skill-creatorSkill
- ui-ux-pro-maxSkill
- vercel-react-best-practicesSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

