dev-docs-generate

Generate standardized developer documentation scaffolds for CRMEB projects.

9.2k|2.1k|Updated Oct 27, 2018
One-click install
npx skills add https://github.com/crmeb/CRMEB --skill dev-docs-generate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-docs-generate
Source: https://github.com/crmeb/CRMEB/tree/main/.trae/skills/dev-docs-generate
Command: npx skills add https://github.com/crmeb/CRMEB --skill dev-docs-generate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The standardized approach to creating developer documentation for CRMEB projects saves time and ensures consistency across the codebase, reducing onboarding time for new contributors.

Core Features & Use Cases

  • Automated scaffolding and templates for developer docs based on project structure.
  • Supports multiple doc formats (Markdown, text, Word, PDF) and frontmatter-guided templates.
  • Triggers automatically when browsing dev-docs, phpapi, admin, uniapp, or nuxt directories to generate / update docs in a central docs directory.

Quick Start

Open the dev-docs directory to auto-generate the standardized development documentation scaffold in the docs folder.

Frequently Asked Questions about dev-docs-generate

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

FAQPage Schema
How do I auto-generate developer documentation for my CRMEB project structure?

Auto-generate developer documentation by opening the dev-docs directory, which triggers automated scaffolding of standardized markdown templates and formatting directly into a central docs folder.

What is the best way to standardize markdown onboarding docs across multiple project directories?

Standardize markdown onboarding docs by applying frontmatter templates, formatting standards, and versioning rules to ensure consistent documentation structure across phpapi, admin, uniapp, and nuxt directories.

Can I automatically scaffold markdown templates when browsing specific codebase directories?

Yes, you can automatically scaffold markdown templates when browsing dev-docs, phpapi, admin, uniapp, or nuxt directories, which triggers the automated creation of starter documentation.

Does the documentation generation workflow support multiple output formats like PDF and Word?

The documentation generation workflow supports multiple output formats including Markdown, text, Word, and PDF, guided by frontmatter templates to maintain consistent documentation publication.

Why do I need automated documentation scaffolding for my codebase?

Automated documentation scaffolding saves time and ensures structural consistency across your codebase, reducing onboarding time for new contributors by providing standardized starter docs and templates.

Are there limitations on which project directories trigger the docs publication workflow?

The docs publication workflow triggers specifically when browsing dev-docs, phpapi, admin, uniapp, and nuxt directories, limiting automated generation to these recognized project structures.