documentation

Enforce Diátaxis documentation standards for HoloViz repository pull requests.

3|Updated May 31, 2023

Search Tags:#documentation #software development #technical writing #api reference #diataxis #holoviz

Ready to run

npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill documentation-subaru-pfs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/Subaru-PFS/spt_etc_webapp/tree/main/.claude/skills/contributing-to-holoviz/skills/documentation
Command: npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill documentation-subaru-pfs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the inconsistency and incompleteness often found in technical documentation by providing a structured framework for writing and reviewing docs, changelogs, and API references.

Core Features & Use Cases

Diátaxis Framework Alignment: Ensures documentation follows the industry-standard structure of tutorials, how-to guides, explanations, and references.
Coverage Verification: Enforces the requirement that all new features, parameters, and behavioral changes must be accompanied by updated documentation.
Use Case: When preparing a pull request for a HoloViz package, use this Skill to audit your documentation against the required standards, ensuring that examples are representative and that all backends are properly covered.

Quick Start

Use the documentation skill to review my current pull request against the Diátaxis framework and identify any missing API references or feature descriptions.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I structure technical documentation using the Diátaxis framework?▼

The Diátaxis framework structures technical documentation into four distinct modes: tutorials, how-to guides, explanations, and references. This Skill enforces that structure for HoloViz repositories to ensure comprehensive coverage of features, parameters, and behavioral changes.

What is the best way to audit a pull request for missing API references?▼

Use this Skill to audit pull requests against required documentation standards. It verifies that all new features, parameters, and behavioral changes include updated API references, feature descriptions, and representative examples with proper backend coverage.

How does changelog verification work for HoloViz software development?▼

Changelog verification enforces comprehensive coverage requirements during the software development lifecycle. It ensures all new features and behavioral changes in HoloViz repositories are accompanied by updated documentation and visual verification of example notebooks.

Do I need to visually verify example notebooks for HoloViz documentation?▼

Yes, visual verification of example notebooks is required. This Skill enforces project-specific build tasks and checks that documentation examples are representative and properly cover all required backends before a pull request can be approved.

When do I need to update API references for new parameters?▼

API references must be updated whenever new features, parameters, or behavioral changes are introduced. This Skill enforces coverage requirements by auditing technical guides and references to ensure all changes are accompanied by corresponding documentation updates.