documentation

Audit repository documentation and plan structured improvements across modules.

1|Updated Dec 8, 2023

Search Tags:#planning #templates #documentation #writing #markdown #audit

Ready to run

npx skills add https://github.com/hydrosolutions/SAPPHIRE_Forecast_Tools --skill documentation-hydrosolutions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/hydrosolutions/SAPPHIRE_Forecast_Tools/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/hydrosolutions/SAPPHIRE_Forecast_Tools --skill documentation-hydrosolutions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation management helps keep repository documentation aligned, reduces gaps, and supports planned improvements across teams.

Core Features & Use Cases

Architecture overview and governance of docs
Audit, planning, and drafting workflows for documentation
Guidance for module READMEs and doc/modules structure

Quick Start

Run an initial documentation audit and plan a set of improvements per the documented plan.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I audit repository documentation for consistency and gaps?▼

Audit repository documentation by running structured workflows that review modules for clarity, enforce templates, and identify gaps. The process defines clear handoffs to ensure repository documentation remains accessible and up-to-date across teams.

What is the best way to plan markdown documentation improvements across modules?▼

Plan markdown documentation improvements by executing a structured planning workflow that defines drafting steps and module README guidance. This governance ensures coherent markdown documentation architecture and planned improvements across teams.

How do I maintain module READMEs and documentation structure as a project grows?▼

Maintain module READMEs and documentation structure by applying enforced templates and structured maintenance workflows. This governance keeps module documentation aligned, accessible, and coherent as the repository scales.

Can I use documentation templates to enforce writing standards across teams?▼

Yes, you can use documentation templates to enforce writing standards across teams. The templates provide structured guidance for audits and drafting, ensuring consistent handoffs and clear module documentation governance.

When should I run a documentation audit on my repository?▼

Run a documentation audit when repository documentation gaps emerge or clarity decreases across modules. The audit workflow identifies inconsistencies, enforces templates, and plans improvements to maintain accessible, up-to-date documentation.