diataxis:reference

Name: diataxis:reference
Availability: InStock
Author: jayteealao

Generate structured technical references for APIs, CLIs, configurations, schemas, and error codes.

2|Updated Jan 12, 2026

Search Tags:#documentation #api #schema #cli #configuration #reference #errors

Ready to run

npx skills add https://github.com/jayteealao/agent-skills --skill diataxis-reference

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: diataxis:reference
Source: https://github.com/jayteealao/agent-skills/tree/main/plugins/sdlc-workflow/skills/reference-writer
Command: npx skills add https://github.com/jayteealao/agent-skills --skill diataxis-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams generate neutral, structured technical references for APIs, CLI commands, configuration keys, schemas, and error codes, enabling fast lookup during development and debugging.

Core Features & Use Cases

Consistent reference structure: API endpoints, CLI commands, config keys, and schemas follow a repeatable template.
Clear scope and boundaries: focuses on factual documentation and avoids onboarding or tutorials.
Rich guidance: includes patterns, constraints, and version compatibility notes to aid engineers and reviewers.
Use case: generate a lookup doc for a new API or CLI feature and publish to the knowledge base.

Quick Start

Ask for a neutral reference for a specific API, CLI, or config item by providing its type and identifier.

Frequently Asked Questions about diataxis:reference

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

FAQPage Schema

How do I generate lookup-ready technical references for API endpoints and CLI commands?▼

Generate lookup-ready technical references by providing the item type and identifier, producing neutral documentation for API endpoints, CLI commands, and configuration keys using a fixed, repeatable template structure.

What is the best way to document configuration keys and error code lists for fast debugging?▼

Documenting configuration keys and error code lists is best handled by generating factual reference tables that emphasize completeness, consistent terminology, and lookup-readiness while excluding onboarding or tutorial content.

Can I use this approach to create schema documentation and version compatibility matrices?▼

Yes, you can use this approach to create schema documentation and version compatibility matrices, as it applies fixed templates per item type and includes constraints and version compatibility notes for engineers.

Does this method work for generating parameter tables for new API features?▼

This method works effectively for generating parameter tables for new API features by applying a consistent reference structure that focuses on factual documentation and avoids onboarding content.

When should I not use a neutral technical reference for my software documentation?▼

You should not use a neutral technical reference when you need onboarding content, tutorials, or conceptual guides, as this approach strictly focuses on factual, lookup-ready documentation for APIs, CLIs, and schemas.

How do I create a CLI command reference that follows a consistent structure?▼

Create a CLI command reference by requesting a neutral reference for a specific CLI item, which applies a repeatable template to ensure consistent terminology, structure, and factual completeness across your documentation.