documentation-platform-selection
Installation
SKILL.md
Documentation Platform Selection
Use this skill to choose, compare, pilot, or migrate documentation platforms and authoring tools. It keeps the decision anchored in reader experience, author workflow, maintenance reality, and migration risk.
This skill is derived from paraphrased guidance in Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 17, "Tools and Content Delivery," plus related maintenance and audience guidance from Chapters 3 and 10. Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - State current pain, target reader experience, author workflow, and constraints.
- Use
workflows/evaluate-doc-platform.mdto compare options. - Use
workflows/plan-doc-migration-pilot.mdwhen migration or pilot planning is needed. - Separate tool problems from process, ownership, and information architecture problems.
- Return requirements, comparison, recommendation, migration risk, pilot plan, and open questions.
Default Output
When evaluating a documentation platform, return: