agentleFS
shkodnik1917shkodnik1917/claude-brainlab/skills/doc-coauthoring/SKILL.md

doc-coauthoring

Skill35 starsChanged 2 months agoMITView on GitHub

Co-authors a technical document, proposal, or specification through context gathering, targeted drafting, and reader-testing review. Use when the user says 'help me write a doc', 'draft a spec', 'write a proposal', 'RFC', or wants to iterate on a design document together.

179 other projects use a version of this, 161 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use context7-efficient, academy-guide and 9 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.
  • hfzarslanSkill

    context7-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

  • AnthropicSkill

    academy-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 6 projects that use this

  • AbdullahMalik17Skill

    configuring-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

  • AbdullahMalik17Skill

    deploying-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

  • AnthropicSkill

    web-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 72 projects that use this

  • Rehan-Ul-HaqSkill

    fetch-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

  • +5 more from AbdullahMalik17

The file

Show its rules and text

We split this skill into the rules it gives an agent

62 rules. 54 are common, 1 is distinctive, and 7 are very specific to this project.

  • 54

    Common

    Most of the 169 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use references/RUNTIME-MATRIX.md to decide what is available in the current environment before offering connectors, artifacts, or …

    line 13
  2. Distinctive:

    If no artifact-like surface is available, default to a normal markdown file in a user-specified path or an explicitly named working file.

    line 15
  3. Common:

    Reader Testing: Test the doc with a fresh Claude (no context) to catch blind spots before others read it

    line 29
  4. Common:

    If user declines, work freeform.

    line 33
  5. Common:

    Start by asking the user for meta-context about the document:

    line 41
  6. Common:

    Ask if they have a template document to share

    line 52
  7. Common:

    If they provide a link to a shared document, use the appropriate integration to fetch it

    line 53
  8. Common:

    If they provide a file, read it

    line 54
  9. Common:

    Use the appropriate integration to read the current state

    line 57
  10. Common:

    Check for images without alt-text

    line 58
  11. Common:

    If images exist without alt-text, explain that when others use Claude to understand the doc, Claude won't be able to see them.

    line 59
  12. Common:

    If user mentions team channels or shared documents:

    line 85
  13. Common:

    If integrations available: Inform them the content will be read now, then use the appropriate integration

    line 86
  14. Common:

    If integrations not available: Explain lack of access.

    line 87
  15. Common:

    If user mentions entities/projects that are unknown:

    line 89
  16. Common:

    Ask if connected tools should be searched to learn more

    line 90
  17. Common:

    Wait for user confirmation before searching

    line 91
  18. Common:

    When user signals they've done their initial dump (or after substantial context provided), ask clarifying questions to ensure understanding:

    line 97
  19. Common:

    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.

    line 107
  20. Common:

    If user wants to add more, let them.

    line 109
  21. Common:

    Start with whichever section has the most unknowns (usually the core decision/proposal), then work through the rest.

    line 123
  22. Common:

    If the document structure is clear: Ask which section they'd like to start with.

    line 127
  23. Common:

    Ask which section they'd like to start with.

    line 128
  24. Common:

    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.

    line 132
  25. Common:

    Ask if this structure works, or if they want to adjust it.

    line 135
  26. Common:

    Create the initial document structure with placeholder text for all sections.

    line 139
  27. Very specific:

    Use create_file to create an artifact.

    line 142
  28. Common:

    Create artifact with all section headers and brief placeholder text like "[To be written]" or "[Content here]".

    line 146
  29. Very specific:

    Create a markdown file in the working directory.

    line 151
  30. Common:

    Create file with all section headers and placeholder text.

    line 155
  31. Common:

    Ask which points should be kept, removed, or combined.

    line 179
  32. Very specific:

    Use str_replace to replace the placeholder text for this section with the actual drafted content.

    line 195
  33. Common:

    After drafting, provide a link to the artifact.

    line 200
  34. Common:

    Ask them to read through it and indicate what to change.

    line 202
  35. Common:

    After drafting, confirm completion.

    line 205
  36. Very specific:

    Use str_replace to make edits (never reprint the whole doc)

    line 215
  37. Common:

    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 …

    line 218
  38. Common:

    After 3 consecutive iterations with no substantial changes, ask if anything can be removed without losing important information.

    line 224
  39. Common:

    When section is done, confirm [SECTION NAME] is complete.

    line 226
  40. Common:

    Read entire document and provide feedback.

    line 238
  41. Common:

    Ask if ready to move to Reader Testing, or if they want to refine anything else.

    line 247
  42. Common:

    Goal: Test the document with a fresh Claude (no context bleed) to verify it works for readers.

    line 251
  43. Common:

    Ask what questions people might ask when trying to discover this document.

    line 303
  44. Common:

    Ask Reader Claude the generated questions

    line 312
  45. Common:

    Check if Reader Claude gives correct answers or misinterprets anything.

    line 319
  46. Common:

    Ask what Reader Claude got wrong or struggled with.

    line 330
  47. Common:

    When Reader Claude consistently answers questions correctly and doesn't surface new gaps or ambiguities, the doc is ready.

    line 338
  48. Common:

    When Reader Testing passes: Announce the doc has passed Reader Claude testing.

    line 342
  49. Common:

    Ask them to verify it achieves the impact they wanted

    line 347
  50. Common:

    Ask if they want one more review, or if the work is done.

    line 349
  51. Common:

    Consider linking this conversation in an appendix so readers can see how the doc was developed

    line 353
  52. Common:

    Use appendices to provide depth without bloating the main doc

    line 354
  53. Common:

    Update the doc as feedback is received from real readers

    line 355
  54. Common:

    Don't try to "sell" the approach - just execute it

    line 362
  55. Common:

    If user wants to skip a stage: Ask if they want to skip this and write freeform

    line 365
  56. Common:

    If user seems frustrated: Acknowledge this is taking longer than expected.

    line 366
  57. Common:

    Always give user agency to adjust the process

    line 367
  58. Common:

    Don't let gaps accumulate - address them as they come up

    line 371
  59. Very specific:

    Use create_file for drafting full sections

    line 374
  60. Very specific:

    Use str_replace for all edits

    line 375
  61. Common:

    Never use artifacts for brainstorming lists - that's just conversation

    line 377
  62. Common:

    Don't rush through stages

    line 380

“Common” is measured: kept by at least 6 in 10 of the 169 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

Runtime contract

Use references/RUNTIME-MATRIX.md to decide what is available in the current environment before offering connectors, artifacts, or reader-test subagents.

If no artifact-like surface is available, default to a normal markdown file in a user-specified path or an explicitly named working file. Do not assume artifacts are available.

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:

  1. Context Gathering: User provides all relevant context while Claude asks clarifying questions
  2. Refinement & Structure: Iteratively build each section through brainstorming and editing
  3. Reader Testing: Test the doc with a fresh Claude (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 Claude). 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 Claude knows, enabling smart guidance later.

Initial Questions

Start by asking the user for meta-context about the document:

  1. What type of document is this? (e.g., technical spec, decision doc, proposal)
  2. Who's the primary audience?
  3. What's the desired impact when someone reads this?
  4. Is there a template or specific format to follow?
  5. 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 Claude to understand the doc, Claude 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 Claude.ai or Claude app: Suggest they can enable connectors in their Claude 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 Claude 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:

  1. Clarifying questions will be asked about what to include
  2. 5-20 options will be brainstormed
  3. User will indicate what to keep/remove/combine
  4. The section will be drafted
  5. 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 Claude 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_replace to 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 Claude (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 Claude Code):

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 Claude instance (no context from this conversation).

For each question, invoke a sub-agent with just the document content and the question.

Summarize what Reader Claude 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 Claude 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., claude.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 Claude.ai?

Generate 5-10 questions that readers would realistically ask.

Step 2: Setup Testing

Provide testing instructions:

  1. Open a fresh Claude conversation: https://claude.ai
  2. Paste or share the document content (if using a shared doc platform with connectors enabled, provide the link)
  3. Ask Reader Claude the generated questions

For each question, instruct Reader Claude to provide:

  • The answer
  • Whether anything was ambiguous or unclear
  • What knowledge/context the doc assumes is already known

Check if Reader Claude gives correct answers or misinterprets anything.

Step 3: Additional Checks

Also ask Reader Claude:

  • "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 Claude 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 Claude 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 Claude testing. Before completion:

  1. Recommend they do a final read-through themselves - they own this document and are responsible for its quality
  2. Suggest double-checking any facts, links, or technical details
  3. 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_file for drafting full sections
  • Use str_replace for 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

Reference Files

Load only what is needed:

  • references/RUNTIME-MATRIX.md - how to adapt the workflow to Claude Code, Claude.ai, connector-rich, and connector-poor environments
  • references/DOC-TYPES.md - default section scaffolds for common document types
  • references/READER-TEST.md - reader-testing prompts, handoff package, and pass/fail signals

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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.