doc-coauthoring

Included with Lifetime

$97 forever

Guide users through structured collaborative documentation creation. Use when user wants to write documentation, update README, create architecture docs, draft proposals, technical specs, decision docs, refactor documentation, create API docs, or document code.

Backend & APIs

What this skill does


# Doc Co-Authoring Workflow

Collaborative workflow for creating documentation that works for readers.

## When to Offer This Workflow

**Trigger conditions:**
- Writing documentation: "write a doc", "draft a proposal", "create a spec", "write up"
- Code documentation: "write README", "create API docs", "document this code", "architecture docs"
- Specific doc types: "PRD", "design doc", "decision doc", "RFC", "technical spec"
- User starting any substantial writing task

## Workflow Variants

| Variant | Stages | Use For |
|---------|--------|---------|
| **Full Collaborative** | Context Gathering → Refinement → Reader Testing | Proposals, specs, decisions, RFCs |
| **Streamlined Collaborative** | Context Gathering → Refinement | READMEs, API docs, architecture guides |

Both variants use collaborative principles (clarifying questions, iterative refinement). Streamlined skips Reader Testing since code docs have different validation (working examples, API accuracy).

## Three Stages Overview

### Stage 1: Context Gathering
Close the gap between what the user knows and what Claude knows. Ask about doc type, audience, desired impact, and template. Encourage info dumping. Ask clarifying questions until understanding is sufficient.

### Stage 2: Refinement & Structure
Build the document section by section. For each section: ask clarifying questions, brainstorm options, let user curate, draft, and refine through surgical edits. Use code documentation patterns as scaffolds for READMEs, APIs, etc.

### Stage 3: Reader Testing (Full Collaborative only)
Test the document with a fresh Claude (no context bleed) to verify it works for readers. If sub-agents available, test directly. Otherwise, guide user through manual testing.

## Initial Offer Template

When triggered, offer the workflow:

```
I can help you write that [doc type]. I use a structured workflow that helps
ensure the doc works well when others read it:

1. **Context Gathering**: You share relevant context while I ask clarifying questions
2. **Refinement & Structure**: We build each section through brainstorming and iteration
3. **Reader Testing**: We test the doc with a fresh Claude to catch blind spots
   (or skip for code docs like READMEs)

Would you like to try this workflow, or prefer to work freeform?
```

## Code Documentation Patterns

For code docs, select the appropriate pattern as the starting scaffold:

| Doc Type | Pattern |
|----------|---------|
| README | Features, Installation, Quick Start, Config, API, Contributing |
| API Docs | OpenAPI spec with paths, schemas, examples |
| Architecture | Overview, Component Diagram, Components table, Data Flow |
| Configuration | Required/Optional vars table, example config |
| Module | Purpose, Architecture diagram, Components, Methods table |

See [WORKFLOW.md](WORKFLOW.md) for complete patterns.

## Resources

- [WORKFLOW.md](WORKFLOW.md) - Full stage procedures and code patterns
- [EXAMPLES.md](EXAMPLES.md) - Complete templates for proposals, specs, READMEs
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Common issues and solutions

## Tips

- **Be direct and procedural** - explain rationale briefly when it affects user behavior
- **Give user agency** - always allow them to skip stages or work freeform
- **Track context** - address gaps as they come up, don't let them accumulate
- **Use surgical edits** - never reprint entire doc, use str_replace
- **Quality over speed** - each iteration should make meaningful improvements
- **For code docs** - verify examples work, check API signatures against actual code

Files: 4

Size: 53.1 KB

Complexity: 38/100

Category: Backend & APIs

Source: https://github.com/joaquimscosta/arkhe-claude-plugins/tree/main/plugins/doc/skills/doc-coauthoring

Related in Backend & APIs

jfrog

Included

Interact with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.

Backend & APIsscripts

cupynumeric-migration-readiness

Included

Pre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.

Backend & APIsscripts

alibabacloud-data-agent-skill

Included

Invoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".

Backend & APIsscripts

token-optimizer

Included

Reduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.

Backend & APIsscripts

resend-cli

Included

Use this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.

Backend & APIsscripts

alibabacloud-odps-maxframe-coding

Included

Use this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.

Backend & APIsscripts