documentation-best-practices

Standardize MTG Agent project documentation with templates for tasks, verification, and rollback procedures.

Updated Nov 2, 2025
One-click install
npx skills add https://github.com/andy-fawcett/mtg-agent --skill documentation-best-practices-andy-fawcett
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-best-practices
Source: https://github.com/andy-fawcett/mtg-agent/tree/main/.claude/skills/documentation-best-practices
Command: npx skills add https://github.com/andy-fawcett/mtg-agent --skill documentation-best-practices-andy-fawcett

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill provides standards and templates to ensure consistent, professional documentation across the MTG Agent project, including phase planning, task breakdowns, verification steps, and rollback procedures.

Core Features & Use Cases

  • Standardized templates for Task Documentation, Verification Steps, Phase Readmes
  • Guidelines for rollback procedures and testing
  • Commit message best practices and documentation maintenance
  • Processes for phase progress tracking and documentation governance

Quick Start

Start by reviewing the bundled templates in references/task-template.md, references/verification-template.md, and assets/phase-readme-template.md. Then create or update a phase README and task documents using these templates, customizing sections to reflect scope, objectives, and verification criteria.

Frequently Asked Questions about documentation-best-practices

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

FAQPage Schema
How do I standardize project documentation templates for phase planning and task breakdowns?

Standardize project documentation templates by enforcing frontmatter usage and structured phase documents. This provides consistent formats for task breakdowns, phase planning, and ongoing documentation maintenance across your team.

What should a rollback procedure document include for software development phases?

A rollback procedure document should include standardized verification steps and testing guidelines. Using a dedicated rollback template ensures you capture critical recovery actions and validation criteria before deployment.

What are the best practices for writing commit messages in a structured development project?

Commit message best practices involve following standardized conventions provided by documentation guidelines. This ensures consistent, professional commit histories that align with phase tracking and task verification standards.

How do I track phase progress and maintain documentation governance across a development team?

Track phase progress and maintain documentation governance by using structured phase READMEs and task templates. This enforces documentation consistency, standardizes progress tracking, and ensures ongoing maintenance across the project.

Do I need specific frontmatter formats for phase READMEs and task documentation?

Yes, standardized frontmatter usage is required for phase READMEs and task documentation. Enforcing frontmatter ensures documentation consistency, enables reliable phase tracking, and maintains professional quality across all project documents.

Can I customize task and verification templates for different project scopes and objectives?

Yes, you can customize task and verification templates to reflect specific scope, objectives, and verification criteria. The bundled templates provide a standardized baseline that you adapt for each phase while maintaining overall consistency.