docs: add PRODUCT.md and documentation map - #31
Merged
Conversation
Add docs/PRODUCT.md capturing product vision, target users, differentiation, capability-level requirements, and explicit non-goals (Mosh, core-embedded AI, DOM-based desktop UI, mandatory daemon). Reviewed at each minor/major release. Add a Documentation Map & Roles section to CLAUDE.md / CLAUDE.ja.md defining one job per persistent document (CLAUDE.md / PRODUCT.md / ARCHITECTURE.md / adr / plans / CHANGELOG), and link PRODUCT.md from both README documentation maps. Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
Coverage reportGenerated by |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/PRODUCT.md— a product requirements document capturing vision, target users, differentiation vs other terminals, capability-level requirements per area, and explicit non-goals (Mosh, core-embedded AI assistant, DOM-based desktop UI, mandatory daemon). Update policy: reviewed at each minor/major release alongside CHANGELOG.CLAUDE.md(andCLAUDE.ja.md) defining one job per persistent document: CLAUDE.md (how to work) / PRODUCT.md (what & why) / ARCHITECTURE.md (how it is built) / adr (why decided) / plans (steering files for units of work) / CHANGELOG (release history).docs/PRODUCT.mdwhen bumping minor/major versions.docs/PRODUCT.mdfrom the documentation maps inREADME.md/README.ja.md.Background
Gap analysis against Claude Code official guidance and the existing docs tree showed the repo already has architecture, protocol, ADR, threat-model, and phased-plan documents — the only missing persistent document was a PRD. This PR fills that gap and codifies the role separation so content is written once in the file that owns it.
Test plan
docs/PRODUCT.mdverified to resolve🤖 Generated with Claude Code