Skip to main content Skills Marketplace Descubra e explore skills de IA criadas pela comunidade.
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Mostrar detalhes do prompt Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.
npx skills add https://github.com/tomevault-io/skills-registry --skill eaa-design-managementO comando permanece em uma só linha. Role horizontalmente para revisá-lo antes de copiar.
Prefere uma cópia local? Baixe os arquivos disponíveis atualmente no SkillsMP.
Baixar Zip Baixando... Ocupações relacionadas SOC
Baseado na classificação ocupacional SOC
Explorador de arquivos
2 arquivos name eaa-design-management description Use when managing design documents. Trigger with design search, validation, or creation requests. version 1.0.0 license Apache-2.0 compatibility Requires Python 3.10 or higher. Requires AI Maestro installed. metadata {"author":"Emasoft"} agent eaa-main context fork user-invocable false workflow-instruction Step 7 procedure proc-create-design
Design Document Management
Overview
This skill provides comprehensive tooling for managing design documents in the design/ directory hierarchy. It covers creating documents from templates, searching with structured queries, and validating frontmatter compliance.
Prerequisites
Before using this skill, ensure:
Python 3.10 or higher is installed
The design/ directory structure exists in the project root
Write access to the design document directories
Instructions
Read the UUID Specification reference to understand the GUUID format
Review the Document Types reference to select the appropriate document type for your needs
Use the Creating Documents reference to create new design documents with proper frontmatter
Use the Searching Documents reference to query and filter existing documents by metadata or content
Use the Validating Documents reference to ensure all documents meet frontmatter compliance requirements
Consult the Troubleshooting reference if you encounter errors or validation issues
Checklist
Copy this checklist and track your progress:
Output
Output Type Description Example Created Document
New markdown file with UUID-based filename and populated frontmatter
design/pdr/GUUID-20250129-0001-feature-name.md
Search Results JSON JSON array of matching documents with metadata [{"uuid": "GUUID-...", "title": "...", "status": "..."}]
Search Results Table Human-readable table of matching documents ASCII table with columns for UUID, Title, Status, Type
Validation Report List of errors and warnings with file paths and line numbers ERROR: design/pdr/doc.md:3 - Missing required field 'uuid'
Validation Summary Count of files validated, errors found, and overall status Validated 42 files: 40 passed, 2 failed
Quick Start Create a new design document (30 seconds):
python scripts/eaa_design_create.py --type pdr --title "My Feature Design"
Search existing documents:
python scripts/eaa_design_search.py --type pdr --status approved
python scripts/eaa_design_validate.py --all
Core Workflow Sequence This skill teaches design document management in the following order:
UUID Specification - Understand the GUUID format for unique identificationDocument Types - Learn the six document type categoriesCreating Documents - Use templates to create new documentsSearching Documents - Query documents by metadata and contentValidating Documents - Ensure frontmatter complianceTroubleshooting - Handle common issues and edge cases
Reference Documentation Structure Each reference document focuses on a specific aspect of design management. Read them in order for initial learning, or jump directly to the relevant section when you need specific information.
UUID Format Specification
When you need to understand the UUID format - UUID Format Definition
When you need to generate a UUID manually - Manual UUID Generation
When you need to verify UUID validity - UUID Validation Rules
When parsing UUIDs from documents - UUID Parsing
The GUUID-YYYYMMDD-NNNN format specification
Date component requirements (YYYYMMDD)
Sequence number rules (NNNN)
Uniqueness guarantees within a day
Manual vs automatic UUID generation
Document Types
When you need to choose a document type - Type Selection Guide
When creating a Product Design Review - PDR Documents
When writing technical specifications - Spec Documents
When documenting features - Feature Documents
When recording architecture decisions - Decision Documents
When documenting system architecture - Architecture Documents
When creating reusable templates - Template Documents
The six document type categories (pdr, spec, feature, decision, architecture, template)
When to use each document type
Directory structure organization
Type-specific frontmatter fields
Creating Documents
When creating a new design document - Basic Document Creation
When you need a specific author or description - Optional Fields
When you want a custom filename - Custom Filenames
When validation fails after creation - Post-Creation Validation
When the script reports an error - Creation Error Handling
Using eaa_design_create.py with required arguments
Specifying optional metadata (author, description)
Automatic UUID generation
Template population
File placement in correct subdirectory
Post-creation validation
Searching Documents
When searching by UUID - UUID Search
When filtering by document type - Type Filter
When filtering by status - Status Filter
When searching document content - Keyword Search
When using file patterns - Glob Pattern Search
When combining multiple filters - Combined Filters
When no results are returned - Empty Results Handling
Using eaa_design_search.py with different filters
Combining multiple search criteria
Output formats (JSON and table)
Handling empty results
Interpreting search results
Validating Documents
When validating a single document - Single File Validation
When validating all documents - Bulk Validation
When validation reports errors - Understanding Errors
When validation reports warnings - Understanding Warnings
When fixing validation issues - Error Resolution
Using eaa_design_validate.py for single and bulk validation
Required frontmatter fields
Error messages and line numbers
Warning vs error severity
Fixing common validation issues
Error Handling
If UUID generation fails - UUID Generation Issues
If document creation fails - Creation Failures
If search returns no results - Search Issues
If validation reports malformed frontmatter - Frontmatter Parsing Issues
If files are in wrong directories - Directory Structure Issues
Diagnosing common failure modes
Fixing malformed frontmatter
Handling file permission issues
Resolving encoding problems
Recovery procedures
Quick Reference Commands
python scripts/eaa_design_create.py --type pdr --title "Feature Design"
python scripts/eaa_design_create.py --type feature --title "OAuth" --author "John"
python scripts/eaa_design_create.py --type spec --title "API Spec" --filename "api-v2"
python scripts/eaa_design_search.py --uuid GUUID-20250129-0001
python scripts/eaa_design_search.py --type pdr --status approved
python scripts/eaa_design_search.py --keyword "authentication"
python scripts/eaa_design_search.py --type feature --format table
python scripts/eaa_design_validate.py design/pdr/my-design.md
python scripts/eaa_design_validate.py --all
python scripts/eaa_design_validate.py --all --type pdr
python scripts/eaa_design_validate.py --all --verbose --format text
Document Status Workflow Status Meaning Next Steps draftInitial creation, work in progress Complete content, request review reviewUnder review by stakeholders Address feedback, approve or revise approvedApproved for implementation Begin implementation implementedImplementation complete Monitor, update if needed deprecatedNo longer current Reference replacement document rejectedNot approved for implementation Document reasons, archive
Frontmatter Reference ---
uuid: GUUID-20250129-0001
title: "Document Title"
status: draft
created: 2025-01-29
updated: 2025-01-29
---
---
type: pdr
author: "Author Name"
description: "Brief description"
tags: [api , security , v2 ]
related: [GUUID-20250128-0003 , GUUID-20250127-0001 ]
---
Directory Structure design/
pdr/ - Product Design Reviews
spec/ - Technical Specifications
feature/ - Feature Documents
decision/ - Architecture Decision Records
architecture/ - System Architecture Documents
template/ - Reusable Templates
Examples
Example 1: Create a New PDR Document
python scripts/eaa_design_create.py --type pdr --title "User Authentication Redesign"
Example 2: Search and Validate Documents
python scripts/eaa_design_search.py --type pdr --status approved --format table
python scripts/eaa_design_validate.py --all --verbose
Resources
Skill Version: 1.0.0
Last Updated: 2025-01-29
Maintainer: Skill Development Team
Converted and distributed by TomeVault — claim your Tome and manage your conversions.
