documentation-organization

Enforce documentation organization and author framework docs for Databricks projects.

5|6|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/databricks-solutions/vibe-coding-workshop-template --skill documentation-organization
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-organization
Source: https://github.com/databricks-solutions/vibe-coding-workshop-template/tree/main/data_product_accelerator/skills/admin/documentation-organization
Command: npx skills add https://github.com/databricks-solutions/vibe-coding-workshop-template --skill documentation-organization

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enforces consistent documentation organization and naming conventions, and it orchestrates the creation of comprehensive framework documentation sets, ensuring projects are well-documented and maintainable.

Core Features & Use Cases

  • Organizational Enforcement: Automatically routes new documentation files to the correct subdirectories (e.g., docs/deployment/, docs/troubleshooting/), enforces naming conventions (kebab-case, date-prefixed), and suggests cleanup for misplaced files in the root directory.
  • Framework Documentation Authoring: Guides users through creating complete documentation sets for technical frameworks using fill-in-the-blank templates, covering architecture, implementation, operations, and troubleshooting.
  • Use Case: When you create a new .md file, this Skill will automatically suggest the correct location (e.g., docs/deployment/deployment-guide.md) and naming convention, and if you ask to document a complex system, it will generate a full set of architecture, implementation, and operations guides.

Quick Start

Use the documentation-organization skill to create a new deployment checklist for your project.

Frequently Asked Questions about documentation-organization

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

FAQPage Schema
How do I enforce documentation naming conventions and file placement in a project?

Documentation organization enforces consistent file placement and naming conventions by automatically routing new markdown files to correct subdirectories and applying kebab-case, date-prefixed naming standards. It also suggests cleanup for misplaced files in the root directory.

What is the best way to generate comprehensive framework documentation sets?

Framework documentation authoring guides users through creating complete technical documentation sets using fill-in-the-blank templates. It orchestrates the generation of architecture, implementation, operations, and troubleshooting guides for complex systems.

How do I structure technical documentation for a Databricks project?

Structuring technical documentation for Databricks projects involves enforcing organizational standards for file placement and naming. The process routes files to specific subdirectories like deployment or troubleshooting, ensuring comprehensive framework documentation sets are maintained.

Can I automatically route markdown files to specific subdirectories like deployment or troubleshooting?

Yes, organizational enforcement automatically routes new documentation files to correct subdirectories such as deployment or troubleshooting. It applies kebab-case naming conventions and identifies misplaced files in the root directory for cleanup.

Does the framework documentation authoring cover operations and troubleshooting guides?

Yes, framework documentation authoring covers operations and troubleshooting guides. It uses fill-in-the-blank templates to orchestrate the creation of complete technical documentation sets, including architecture and implementation guides for technical frameworks.

When should I use fill-in-the-blank templates for documenting complex systems?

Use fill-in-the-blank templates when documenting complex technical frameworks to ensure comprehensive coverage. This approach orchestrates the creation of complete architecture, implementation, operations, and troubleshooting documentation sets systematically.