doc-coauthoring

Guide structured co-authoring of technical specs with reader testing.

1|Updated May 7, 2022
One-click install
npx skills add https://github.com/brandonburrus/dotfiles --skill doc-coauthoring-brandonburrus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/brandonburrus/dotfiles/tree/main/.agents/skills/doc-coauthoring
Command: npx skills add https://github.com/brandonburrus/dotfiles --skill doc-coauthoring-brandonburrus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

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

Core Features & Use Cases

  • Structured Workflow: Guides users through context gathering, iterative drafting, and reader testing.
  • Context Management: Efficiently collects and organizes necessary background information.
  • Iterative Refinement: Builds documents section by section with user feedback.
  • Reader Testing: Simulates a new reader's perspective to identify ambiguities and gaps.
  • Use Case: When starting a new technical specification, this Skill helps gather all necessary background, brainstorm technical approaches, draft each section collaboratively, and finally test it to ensure it's understandable for future readers.

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 specifications collaboratively?

To co-author technical specifications, this Skill guides you through a structured workflow for context gathering, iterative drafting section by section, and simulating reader comprehension testing.

What is the best way to write a structured proposal while ensuring reader comprehension?

The best way to write a structured proposal while ensuring reader comprehension is to use a workflow that iteratively refines content and tests the document from a new reader's perspective to identify ambiguities.

Can I use this to gather context for decision documents before drafting?

Yes, you can use this Skill to gather context for decision documents before drafting, as it efficiently collects and organizes necessary background information to streamline the creation process.

How does iterative refinement work when writing documentation?

Iterative refinement when writing documentation works by collaboratively building the document section by section while incorporating user feedback at each stage to ensure clarity and completeness.

What types of content creation does this workflow support?

This workflow supports content creation for various document types, specifically technical specs, proposals, and decision documents, focusing on structured technical writing and collaboration.

Why simulate a new reader's perspective when finalizing technical writing?

Simulating a new reader's perspective when finalizing technical writing identifies gaps and ambiguities in the documentation, verifying that the structured content achieves reader comprehension before publishing.