本文へ移動
cccskills
無料GitHub で公開

doc-coauthoring

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.

インストール方法を見る

含まれるファイル(4)

  • SKILL.md3.8 KB
  • EXAMPLES.md23.3 KB
  • TROUBLESHOOTING.md6.4 KB
  • WORKFLOW.md19.6 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

VariantStagesUse For
Full CollaborativeContext Gathering → Refinement → Reader TestingProposals, specs, decisions, RFCs
Streamlined CollaborativeContext Gathering → RefinementREADMEs, 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 TypePattern
READMEFeatures, Installation, Quick Start, Config, API, Contributing
API DocsOpenAPI spec with paths, schemas, examples
ArchitectureOverview, Component Diagram, Components table, Data Flow
ConfigurationRequired/Optional vars table, example config
ModulePurpose, Architecture diagram, Components, Methods table

See WORKFLOW.md for complete patterns.

Resources

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

adr

無料

Create, review, and manage Architecture Decision Records (ADRs) with auto-numbering, template detection, quality review, and index maintenance. Use when user mentions "ADR", "architecture decision", "document this decision", "create ADR", "review ADR", editing ADR files (docs/adr/, doc/adr/, .adr/), or discussing architectural choices and tradeoffs.

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

architect

無料

Analyze system architecture, module structure, API contracts, data models, and code patterns. Use when designing systems, reviewing module boundaries, evaluating API designs, analyzing data models, checking pattern conformance, tracing decisions, or reviewing frontend architecture. Triggers: "architecture", "module design", "API design", "data model", "boundaries", "patterns", "decisions", "frontend architecture".

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

Converts natural-language descriptions or UI spec files into optimized Google Stitch prompts. Use when creating, refining, or validating design directives for Google Stitch. Use when user says "create a Stitch prompt", "optimize this for Stitch", "convert this spec to a Stitch prompt", "write a UI prompt", or mentions Google Stitch prompt authoring. Follows Stitch best practices with short, directive prompts focused on screens, structure, and visual hierarchy.

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

Zero-dependency live-preview server providing an agent↔browser bidirectional companion. Watches a content directory, wraps HTML fragments in a frame template, broadcasts live-reload over WebSocket, and captures browser-side click events to a JSONL file. Use when an agent needs to show HTML to the user in a browser and react to clicks — mockups, design exploration, gallery browsing, multi-select choices, prototype iteration. Triggered by "live preview", "browser companion", "preview server", "browser mockup", "show in browser", "arkhe-preview", or any skill that wants to write HTML fragments and have the user see them reload in real time.

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

Deletes merged git branches (local and remote) and flags stale unmerged branches for manual review. Use when user mentions "cleanup branches", "delete merged branches", "prune old branches", "remove stale branches", "branch cleanup", or runs /cleanup-branches command.

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

Interactive Claude Code environment setup wizard. Detects existing configuration, guides through best-practice setup for Global CLAUDE.md, project scaffolding, MCP servers, hooks, custom agents, keybindings, and settings. Use when user runs /devtools:code-env-setup, mentions "setup claude code", "configure claude", "claude code setup", "environment setup", or "initialize claude code".

日本語の概要は準備中です。原文の説明を表示しています。

joaquimscosta/arkhe-claude-plugins212026年8月14日 更新

joaquimscosta のスキルをすべて見る

このスキルの問題を報告する