// Writing/updating project documentation (README, PLAN, PRIVACY-POLICY, NOTICES, changelogs). Use when the user asks to update docs, write changelogs, or modify store listings.
Review code for quality, correctness, and security vulnerabilities. Use when the user asks to review code, audit for security issues, or check for bugs and anti-patterns.
Commit code changes and push via Git. Use when the user asks to commit, push, or save their work to the repository.
Release engineering tasks — version bumping, building release APKs, tagging releases, writing changelogs. Use when the user asks to prepare a release, bump version, tag, or build for distribution.
| name | docs-engineering |
| description | Writing/updating project documentation (README, PLAN, PRIVACY-POLICY, NOTICES, changelogs). Use when the user asks to update docs, write changelogs, or modify store listings. |
| argument-hint | task description |
You are performing documentation tasks for Low Budget Voice Recognition Input.
Current docs (as of milestone 2):
| File | Status | Purpose |
|---|---|---|
PLAN.md | ✅ exists | Implementation plan, milestones, architectural decisions |
Forthcoming (write only when the user asks for them):
| File | Purpose |
|---|---|
README.md | Project overview, build instructions, usage |
PRIVACY-POLICY.md | Required — this app captures microphone audio and downloads a model |
NOTICES.md | Third-party license notices (Gemma terms, ONNX Runtime, etc.) |
CLAUDE.md | Guidance for Claude Code on this codebase |
When updating NOTICES.md, derive the dependency list from gradle/libs.versions.toml and app/build.gradle.kts. Include:
This project supports six recognition languages, but the documentation itself is maintained in two:
Other supported recognition languages (zh-Hans-CN, en-GB, ja, ko) do not require their own docs.
For files like README.md, use interleaved bilingual sections (English heading/paragraph followed by zh-Hant-TW equivalent) — same pattern as the user's other Android projects.
When PRIVACY-POLICY.md is written, it must accurately disclose:
huggingface.co. No telemetry, no analytics, no crash reporting (unless explicitly added later — and if so, must be opt-in and listed here).If the project later adds opt-in telemetry, crash reporting, or any non-local processing, this document must be updated before the feature ships.
The project does not currently ship to F-Droid, Play Store, or any other distribution channel. If/when that changes, ask the user which channels and follow the conventions of that channel — do not assume the previous project's F-Droid setup applies here.