Define documentation standards and coverage parameters

[joshsmithxrm]

Summary

Formalize what should be documented and to what level of detail.

Questions to Answer

1. What must be documented?

   • Every public API?
   • Every CLI command?
   • Every workflow input?

2. What level of detail?

   • Just signatures and descriptions?
   • Full examples for everything?
   • Edge cases and gotchas?

3. What stays in source repos vs ppds-docs?

   • ADRs?
   • Package READMEs?
   • Inline code comments?

4. How to verify completeness?

   • Manual checklist?
   • Automated coverage tool?
   • Ralph Wiggum completion criteria?

Proposed Standards

Must Document

• All NuGet packages (installation, basic usage, API)
• All CLI commands (syntax, options, examples)
• All ALM workflows (inputs, outputs, examples)
• All PowerShell cmdlets (syntax, examples)

Documentation Location

Content	Location
User-facing guides	ppds-docs
API reference	ppds-docs
ADRs	Source repo /docs/adr
Package README	Source repo (links to ppds-docs)
Demo-specific	ppds-demo

Quality Criteria

• All code examples tested
• All internal links valid
• Consistent formatting (style guide)
• No broken external links

Deliverable

Create docs/contributing/documentation-standards.md with these answers.

Priority: Medium

Needed before scaling doc generation with Ralph Wiggum.