aps-doc-core

Generate production-ready documentation from codebase for Treasure Data pipeline layers.

21|24|Updated Oct 21, 2025
One-click install
npx skills add https://github.com/treasure-data/td-skills --skill aps-doc-core
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: aps-doc-core
Source: https://github.com/treasure-data/td-skills/tree/main/aps-doc-skills/core
Command: npx skills add https://github.com/treasure-data/td-skills --skill aps-doc-core

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Core documentation framework for Treasure Data APS; provides shared templates, quality validation, testing, and Confluence integration used across layer-specific documentation skills.

Core Features & Use Cases

  • Shared templates and patterns for ingestion, hist-union, staging, id-unification, and golden layers
  • Quality validation and testing workflows
  • Confluence integration for publishing documentation

Quick Start

Run the APS documentation generator against a codebase to produce consistent docs.

Frequently Asked Questions about aps-doc-core

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

FAQPage Schema
How do I generate production-ready documentation from my Treasure Data pipeline codebase?▼

Generate production-ready documentation by running the APS documentation generator against your codebase to extract actual configurations, SQL, file paths, and line numbers. The tool applies template-driven analysis and validation to produce Confluence-ready docs for ingestion, staging, golden, and other pipeline layers.

What documentation patterns does Treasure Data APS provide for different pipeline layers?▼

APS provides shared templates and patterns for ingestion, hist-union, staging, id-unification, and golden layers. These templates ensure consistent documentation structure across layer-specific documentation skills and enforce quality validation and testing workflows.

Can I create custom documentation that extends the standard layer types?▼

Yes. When documentation doesn't fit standard layer types, use the core documentation generation principles to understand how the framework works, then extend layer-specific skills or implement custom documentation workflows using the same template-driven approach and validation rules.

How do I publish generated documentation to Confluence?▼

The documentation generator includes Confluence integration to publish your production-grade docs directly. After generation and validation, the framework handles formatting and export to Confluence without manual conversion steps.

What data does the documentation generator need from my codebase?▼

The generator requires real codebase access to extract actual configurations, SQL statements, file paths, and line numbers. It performs template-driven analysis and codebase exploration to ensure documentation accuracy and production-grade quality.

Does the documentation framework include quality validation?▼

Yes. The core framework includes built-in quality validation and testing workflows to verify documentation completeness and accuracy before publishing, ensuring consistency across all generated documentation.