{"id":31578353,"url":"https://github.com/guillaumecoi/markdown-use-case-manager","last_synced_at":"2025-10-16T07:09:38.057Z","repository":{"id":317609636,"uuid":"1068123912","full_name":"Guillaumecoi/Markdown-Use-Case-Manager","owner":"Guillaumecoi","description":"A simple CLI tool for managing use cases and scenarios in markdown format. Keep your documentation close to your code and deploy it anywhere.","archived":false,"fork":false,"pushed_at":"2025-10-03T03:51:37.000Z","size":83,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-09T11:21:27.849Z","etag":null,"topics":["documentation","markdown","use-cases","usecase-driven","usecase-testing"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Guillaumecoi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-01T22:24:42.000Z","updated_at":"2025-10-03T03:51:39.000Z","dependencies_parsed_at":"2025-10-02T00:19:45.791Z","dependency_job_id":"f0ebf271-40e2-4224-ab6c-8599058e5027","html_url":"https://github.com/Guillaumecoi/Markdown-Use-Case-Manager","commit_stats":null,"previous_names":["guillaumecoi/md-usecase-manager"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Guillaumecoi/Markdown-Use-Case-Manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guillaumecoi%2FMarkdown-Use-Case-Manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guillaumecoi%2FMarkdown-Use-Case-Manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guillaumecoi%2FMarkdown-Use-Case-Manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guillaumecoi%2FMarkdown-Use-Case-Manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Guillaumecoi","download_url":"https://codeload.github.com/Guillaumecoi/Markdown-Use-Case-Manager/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guillaumecoi%2FMarkdown-Use-Case-Manager/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279164512,"owners_count":26117719,"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-10-16T02:00:06.019Z","response_time":53,"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":["documentation","markdown","use-cases","usecase-driven","usecase-testing"],"created_at":"2025-10-05T19:57:02.800Z","updated_at":"2025-10-16T07:09:38.029Z","avatar_url":"https://github.com/Guillaumecoi.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://capsule-render.vercel.app/api?type=soft\u0026color=0:667eea,100:764ba2\u0026height=160\u0026section=header\u0026text=Markdown%20Use%20Case%20Manager\u0026fontSize=42\u0026fontColor=ffffff\u0026fontAlignY=40\u0026desc=Documentation%20that%20travels%20with%20your%20code\u0026descSize=26\u0026descAlignY=70\" style=\"border-radius: 25px;\"\u003e\n\u003c/div\u003e\n\n## Why This Tool?\n\nMost use case management happens in external tools like Jira or Confluence, which creates a disconnect between your documentation and code. This tool keeps everything together in your repository as plain markdown files.\n\nYour use cases live alongside your code, version-controlled and readable by anyone. No external dependencies, no cloud services, no vendor lock-in. Just markdown files that work with any static site generator or documentation platform.\n\nWorks great for solo developers, small teams, or any project where you want documentation that travels with your code.\n\n## Features\n\n- Organize use cases by categories with automatic ID generation\n- Track progress from planning to deployment\n- Generate consistent documentation and test scaffolding  \n- Prevent conflicts with intelligent naming\n- Export to any markdown-compatible format\n- Support automatic test generation\n- Customizable generation templates\n- Flexible configuration\n\n## Getting Started\n\n### System Installation\n\n```bash\ngit clone https://github.com/GuillaumeCoi/markdown-use-case-manager\ncd markdown-use-case-manager\ncargo install --path .            # Don't forget the dot at the end\n```\n\nNow you can run the tool with `mucm` from anywhere.\n\n### Basic Usage\n\n```bash\n# Initialize your project\nmucm init\n\n# Create your first use case  \nmucm create \"User Login\" --category \"Security\"\n\n# Add scenarios to your use case\nmucm add-scenario \"UC-SEC-001\" \"Login with email and password\"\n\n# View your documentation\nmucm list\nmucm status\n```\n\n### What You Get\n\nCreating use cases generates a clean file structure:\n\n```\ndocs/use-cases/\n├── README.md                    # Auto-generated overview\n├── security/\n│   └── UC-SEC-001.md           # Individual use case \n└── ...\n\ntests/use-cases/\n├── security/\n│   └── uc_sec_001.rs           # Test scaffolding \n└── ...\n```\n\nEverything is standard markdown with YAML frontmatter, so it works with any static site generator.\n\n## Status Tracking\n\nSix development statuses that automatically roll up from scenarios to use cases:\n\n```\nPLANNED 📋      → Basic idea documented\nIN_PROGRESS 🔄  → Development started\nIMPLEMENTED ⚡  → Code complete, not tested\nTESTED ✅       → Tested and verified\nDEPLOYED 🚀     → Live in production\nDEPRECATED ⚠️   → No longer maintained\n```\n\nThe use case status automatically reflects the minimum status of all its scenarios.\n\n## Configuration\n\nConfigure the tool via `.config/.mucm/mucm.toml`:\n\n```toml\n[project]\nname = \"My Project\"\ndescription = \"Project managed with Markdown Use Case Manager\"\n\n[directories]\nuse_case_dir = \"docs/use-cases\"\ntest_dir = \"tests/use-cases\"\n\n[generation]\ntest_language = \"rust\"        # rust, python, or none\nauto_generate_tests = true\n\n...\n```\n\n## Customization 🎨\n\nThe tool is designed to be flexible and adapt to your workflow:\n\n**Custom Templates**: All documentation and test templates are stored in `.config/.mucm/templates/` and can be modified:\n- `use_case_simple.hbs` - Basic use case format\n- `use_case_detailed.hbs` - Detailed use case with scenarios\n- `overview.hbs` - Auto-generated overview page\n- `{language}/test.hbs` - Test scaffolding for your chosen language\n\n## Deployment\n\nSince everything is just markdown, your documentation works everywhere:\n\n- **GitHub/GitLab Pages** - Automatic deployment from your repo\n- **MkDocs** - `mkdocs serve` for instant documentation sites  \n- **Docusaurus** - Modern documentation platform\n- **Jekyll** - GitHub's default static site generator\n- **Hugo** - Fast static site generator\n- **Any markdown processor** - Pandoc, GitBook, etc.\n\n## Contributing\n\nIssues and pull requests welcome!\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumecoi%2Fmarkdown-use-case-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguillaumecoi%2Fmarkdown-use-case-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumecoi%2Fmarkdown-use-case-manager/lists"}