mcpField
D
documentation-platform-selection

documentation-platform-selection

github.com/lvtd-llcDocuments143 installsUpdated 7w ago
Repository

About documentation-platform-selection

A skill for teams choosing, comparing, piloting, or migrating documentation platforms and authoring tools. It grounds decisions in reader and author needs, maintenance, and migration risk, and separates tooling issues from process problems.

Key features

  1. 01Assess reader and author needs
  2. 02Compare platform tradeoffs
  3. 03Plan pilots and migrations
  4. 04Identify process and ownership issues
  5. 05Consider portability and maintenance

Use cases

  1. 01Selecting a documentation platform
  2. 02Comparing authoring tools against requirements
  3. 03Planning a documentation platform pilot
  4. 04Assessing risks before migration

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/lvtd-llc/skills --skill documentation-platform-selection

After installing, type/documentation-platform-selectionin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

guidelines.md
references/core/
knowledge.md
workflows/
evaluate-doc-platform.md
plan-doc-migration-pilot.md

Details

From the project README

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

  1. Load guidelines.md to choose the smallest useful reference set.
  2. State current pain, target reader experience, author workflow, and constraints.
  3. Use workflows/evaluate-doc-platform.md to compare options.
  4. Use workflows/plan-doc-migration-pilot.md when migration or pilot planning is needed.
  5. Separate tool problems from process, ownership, and information architecture problems.
  6. Return requirements, comparison, recommendation, migration risk, pilot plan, and open questions.

Default Output

When evaluating a documentation platform, return:

  1. Decision context - current pain, audiences, content types, team workflow, and constraints.
  2. Requirements - reader, authoring, content model, integration, maintenance, migration, portability, support, and cost.
  3. Option comparison - weighted tradeoffs, fit, risks, and implementation burden.
  4. Process issues - ownership, IA, review, metadata, or maintenance problems that tooling will not fix alone.
  5. Recommendation - keep, improve process, pilot, migrate, or reject.
  6. Pilot or migration plan - scope, success criteria, rollback, owners, and timeline.

Contents

NeedStart Here
Understand platform selection conceptsreferences/core/knowledge.md
Evaluate and compare toolsworkflows/evaluate-doc-platform.md
Plan migration or pilotworkflows/plan-doc-migration-pilot.md
Route by task or symptomguidelines.md

Core Posture

  • Start from reader and author outcomes, not vendor features.
  • Diagnose process problems before blaming tooling.
  • Treat migration as content, URL, metadata, search, and workflow change.
  • Favor portability unless lock-in is an intentional tradeoff.
  • Choose the platform the team can actually maintain.

Comments

Markdown supported