authoring-docs

Create, migrate, and review technical documentation using Markdown and evidence-first workflows.

Updated May 9, 2020
One-click install
npx skills add https://github.com/tkstang/sequence --skill authoring-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: authoring-docs
Source: https://github.com/tkstang/sequence/tree/main/.agents/skills/authoring-docs
Command: npx skills add https://github.com/tkstang/sequence --skill authoring-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of authoring, restructuring, and reviewing technical documentation for software projects, ensuring accuracy and efficiency.

Core Features & Use Cases

  • Documentation Creation: Offers a structured approach to creating documentation based on repository evidence.
  • Documentation Migration: Helps migrate existing documentation into a coherent and usable structure.
  • Documentation Review: Provides a comprehensive review rubric for documentation quality, accuracy, and safety.
  • Use Case: For a software project, use this Skill to organize your existing documentation, ensuring it is reader-friendly and complete.

Quick Start

Use the authoring-docs skill to create a documentation outline for your project.

Frequently Asked Questions about authoring-docs

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

FAQPage Schema
How do I create technical documentation for a software project?

To create technical documentation, this Skill uses a structured workflow based on repository evidence and Markdown, ensuring your software docs are accurate and reader-friendly. It helps generate a documentation outline directly from project files.

What is the best way to review technical documentation for accuracy?

Reviewing technical documentation is best handled through a comprehensive review rubric evaluating quality, accuracy, and safety. This Skill applies structured workflows and evidence-first principles to systematically assess and refine software docs.

How do I migrate existing software documentation into a new structure?

Migrating software documentation is supported through a structured approach that restructures existing content into a coherent, usable format. This Skill streamlines migration, ensuring technical documentation remains organized and complete.

Do I need prior knowledge of documentation principles to use this workflow?

Yes, utilizing this documentation workflow requires existing knowledge of documentation principles and practices. The Skill aids in creation, migration, and review but relies on your understanding of technical documentation standards to function effectively.

What does evidence-first mean for technical documentation authoring?

Evidence-first technical documentation authoring means creating content based directly on repository evidence rather than assumptions. This approach ensures software docs accurately reflect the codebase, improving quality and safety through verifiable sources.