doc-coauthoring

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

Updated Oct 10, 2024
One-click install
npx skills add https://github.com/distolma/dotfiles --skill doc-coauthoring-distolma
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/distolma/dotfiles/tree/main/.agents/skills/doc-coauthoring
Command: npx skills add https://github.com/distolma/dotfiles --skill doc-coauthoring-distolma

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 and reader comprehension.

Core Features & Use Cases

  • Structured Workflow: Guides users through context gathering, iterative drafting, and reader testing.
  • Contextual Understanding: Actively seeks and clarifies user input to build comprehensive documents.
  • Iterative Refinement: Facilitates section-by-section development with brainstorming and editing.
  • Reader Testing: Simulates a new reader's perspective to identify blind spots and ambiguities.
  • Use Case: A product manager needs to draft a new Product Requirements Document (PRD). This Skill will help them gather all necessary context, structure the PRD with appropriate sections, draft content collaboratively, and finally test it to ensure it's clear for all stakeholders.

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
What is the best way to co-author technical specifications and proposals collaboratively?

Co-authoring documentation involves a structured workflow of context gathering, iterative section-by-section refinement, and reader comprehension testing to produce clear proposals and technical specifications.

How do I write a Product Requirements Document (PRD) that ensures reader comprehension?

Writing a PRD with guaranteed reader comprehension requires gathering necessary context, collaboratively drafting structured sections, and running reader testing simulations to identify and resolve any ambiguities.

Can I use this workflow to draft decision documents and technical specs section by section?

Yes, this workflow supports drafting decision documents and technical specs section by section, actively seeking user input to facilitate iterative content refinement and efficient context transfer.

How does reader testing work when refining documentation?

Reader testing works by simulating a new reader's perspective to identify blind spots and ambiguities, verifying that the final documentation is clear and comprehensible for all intended stakeholders.

Do I need to provide initial context to start collaborative content creation?

Yes, providing initial context is required for collaborative content creation, as the workflow actively seeks and clarifies user input to iteratively build comprehensive documents like technical specifications and proposals.