doc-coauthoring

Guide structured co-authoring of technical specs and decision docs.

25|12|Updated Jun 4, 2024
One-click install
npx skills add https://github.com/fairwic/rust_quant --skill doc-coauthoring-fairwic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/fairwic/rust_quant/tree/main/.claude/skills/doc-coauthoring
Command: npx skills add https://github.com/fairwic/rust_quant --skill doc-coauthoring-fairwic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of creating structured documents like proposals, technical specs, and decision docs, ensuring clarity and reader comprehension.

Core Features & Use Cases

  • Structured Workflow: Guides users through context gathering, iterative refinement, and reader testing.
  • Contextual Understanding: Actively asks clarifying questions to build a comprehensive understanding of the document's purpose and content.
  • Iterative Drafting: Brainstorms, curates, and drafts content section by section, incorporating user feedback.
  • Reader Validation: Simulates how a new reader would interact with the document to identify ambiguities and blind spots.
  • Use Case: A product manager needs to write a detailed Product Requirements Document (PRD). This Skill will help them gather all necessary background, structure the PRD logically, draft each section collaboratively, and finally test it to ensure it's clear for engineers and designers.

Quick Start

Use the doc-coauthoring skill to help write a new technical specification document.

Frequently Asked Questions about doc-coauthoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I co-author technical documentation with AI?

Co-authoring technical documentation involves a structured workflow of context gathering, iterative drafting, and simulated reader validation to ensure clarity. This process actively prompts you for clarifying details to build a comprehensive understanding before drafting sections.

What is the best way to write a Product Requirements Document (PRD)?

Writing a Product Requirements Document (PRD) is best handled through a multi-stage process that gathers background, structures the PRD logically, and drafts iteratively. It then tests the document to ensure it is clear for engineers and designers.

How does simulated reader testing work for technical specs?

Simulated reader testing for technical specs works by having an AI emulate how a new reader interacts with the document. This identifies ambiguities and blind spots to ensure reader comprehension and document effectiveness before finalizing.

Can I use this for writing decision docs and proposals?

Yes, you can use this structured workflow for writing decision docs and proposals. It actively asks clarifying questions to build a comprehensive understanding of your document's purpose and iteratively refines content section by section.

Do I need to provide full content upfront to start iterative drafting?

No, you do not need to provide full content upfront to start iterative drafting. The process begins with context gathering where it actively asks clarifying questions, then brainstorms and curates content while incorporating your feedback section by section.