{"id":29955058,"url":"https://github.com/al3rez/yamlprd","last_synced_at":"2025-08-03T17:09:40.100Z","repository":{"id":305664735,"uuid":"1023538374","full_name":"al3rez/yamlprd","owner":"al3rez","description":"YAML PRD Specification - Token-efficient, machine-readable product requirement documents for AI-powered development","archived":false,"fork":false,"pushed_at":"2025-07-21T10:10:12.000Z","size":5,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-02T07:35:07.022Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/al3rez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-21T10:05:49.000Z","updated_at":"2025-07-29T16:45:53.000Z","dependencies_parsed_at":"2025-07-21T12:11:41.333Z","dependency_job_id":"17d7ca42-e50b-438c-87bd-921d733e9667","html_url":"https://github.com/al3rez/yamlprd","commit_stats":null,"previous_names":["al3rez/yamlprd"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/al3rez/yamlprd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fyamlprd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fyamlprd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fyamlprd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fyamlprd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/al3rez","download_url":"https://codeload.github.com/al3rez/yamlprd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/al3rez%2Fyamlprd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268578914,"owners_count":24273089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-03T17:09:25.730Z","updated_at":"2025-08-03T17:09:40.093Z","avatar_url":"https://github.com/al3rez.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAML PRD Specification\n\n## Why YAML PRDs\n\nYAML PRDs reduce token consumption by 40-60% and eliminate hallucination risks through structured, machine-readable specifications.\n\n### Key Benefits\n1. **Token Efficiency**: Hierarchical key-value structure without filler words\n2. **Zero Ambiguity**: Explicit values prevent misinterpretation\n3. **Machine-Readable**: Native parsing, consistent structure, type safety\n4. **Version Control**: Line-by-line diffs, easy merges, inline comments\n\n## Core Structure\n\n```yaml\nprd:\n  title: string\n  purpose: string\n  features:\n    - id: string\n      user_story: string\n  metrics:\n    - metric: string\n      target: string\n  constraints:\n    - string\n```\n\n## Example: Virtual Try-On Marketplace\n\n```yaml\nprd:\n  title: Virtual Try-On Clothing Marketplace\n  purpose: Allow users to sell clothes and try on outfits virtually using AI\n  \n  features:\n    - id: F1\n      user_story: \"As a user, I can list clothes for sale with images and details\"\n    - id: F2  \n      user_story: \"As a user, I can try on clothes virtually using my photo\"\n    - id: F3\n      user_story: \"As a user, I can purchase clothes from other users\"\n  \n  metrics:\n    - metric: TryOn_Engagement_Rate\n      target: \"60% of users complete first try-on\"\n    - metric: Listing_Conversion\n      target: \"40% of items sold within 30 days\"\n  \n  constraints:\n    - \"5 free try-ons per user\"\n    - \"One full-body photo per account\"\n    - \"10MB max image size\"\n```\n\n## Best Practices\n\n### Keep It DRY\n```yaml\n# Use references for repeated structures\ndefinitions:\n  \u0026user_fields\n    id: uuid\n    email: string\n\nschemas:\n  user: *user_fields\n  seller: \n    \u003c\u003c: *user_fields\n    listings: array\n```\n\n### Be Explicit\n```yaml\ntimeout_seconds: 30  # Not just \"timeout: 30\"\nmax_file_size_mb: 10  # Not just \"size: 10\"\n```\n\n## Converting PDFs to YAML PRDs\n\n### Quick Start\n```bash\n# Install dependencies\npip install -r requirements.txt\n\n# Convert PDF to YAML PRD template\npython pdf2yaml.py document.pdf\n\n# Or specify output file\npython pdf2yaml.py document.pdf -o my-prd.yaml\n\n# Get markdown only\npython pdf2yaml.py document.pdf --markdown-only\n```\n\n### CLI Options\n- `-o, --output`: Specify output file path\n- `-m, --markdown-only`: Output markdown without YAML template\n- `--keep-headers`: Keep PDF headers/footers\n- `--include-empty-tables`: Include empty tables\n\n### Alternative Tools\n- **Web**: https://pdf2md.morethan.io/ - Convert PDF to Markdown online\n- **Python**: `pip install pdf2markdown4llm` - Direct library usage\n\n## Results\n\n| Metric | YAML PRD | Traditional PRD |\n|--------|----------|-----------------|\n| Tokens | 500-1000 | 2000-5000 |\n| AI Accuracy | 100% | 70-85% |\n| Update Time | Seconds | Hours |\n\n## Extended Structure (When Needed)\n\n```yaml\nprd:\n  # Core fields as above\n  \n  technical_specs:  # Optional\n    api:\n      - endpoint: /api/v1/resource\n        method: POST\n    database:\n      table_name:\n        column: type\n  \n  dependencies:  # Optional\n    - name: service_name\n      version: \"\u003e=1.0\"\n  \n  testing:  # Optional\n    coverage: 80\n    scenarios:\n      - name: string\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fal3rez%2Fyamlprd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fal3rez%2Fyamlprd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fal3rez%2Fyamlprd/lists"}