Skip to content

Commit 869d3fb

Browse files
proof-developer[bot]proof-dev
andauthored
docs: split customer docs from internal project docs (#828)
Co-authored-by: proof-dev <proof-dev@socialproof.dev>
1 parent 5110a0d commit 869d3fb

38 files changed

Lines changed: 44 additions & 12 deletions

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ apps/
2525
blog/ Blog (CF Pages)
2626
docs/ Docs site
2727
infra/ IaC / config
28-
project/ Strategy docs, roadmap, status
28+
project-docs/ Internal strategy docs, runbooks, roadmap, status
2929
```
3030

3131
## Stack
@@ -118,11 +118,11 @@ cd apps/worker && npm run test:watch
118118

119119
---
120120

121-
## Project Docs
121+
## Internal Project Docs
122122

123123
| Doc | Description |
124124
|-----|-------------|
125-
| [project/vision.md](project/vision.md) | Product vision, positioning, what we build |
126-
| [project/roadmap.md](project/roadmap.md) | Current sprint and milestones |
127-
| [project/user-stories.md](project/user-stories.md) | Expected behaviour — use for QA and test writing |
128-
| [project/activation-first-strategy.md](project/activation-first-strategy.md) | Why activation > conversion right now |
125+
| [project-docs/vision.md](project-docs/vision.md) | Product vision, positioning, what we build |
126+
| [project-docs/roadmap.md](project-docs/roadmap.md) | Current sprint and milestones |
127+
| [project-docs/user-stories.md](project-docs/user-stories.md) | Expected behaviour — use for QA and test writing |
128+
| [project-docs/activation-first-strategy.md](project-docs/activation-first-strategy.md) | Why activation > conversion right now |

docs/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# `docs/` vs `project-docs/`
2+
3+
This repo has two documentation homes on purpose:
4+
5+
- `docs/` = customer-facing product documentation and public-facing support content
6+
- `project-docs/` = internal project documentation, playbooks, runbooks, strategy notes, ADRs, and working docs
7+
8+
## Put files in `docs/` when
9+
10+
The content is written for customers, prospects, or external users of SocialProof.
11+
Examples:
12+
- getting started / quickstart guides
13+
- embedding instructions
14+
- collecting testimonials
15+
- public product guides and help content
16+
17+
## Put files in `project-docs/` when
18+
19+
The content is written for the team operating or building SocialProof.
20+
Examples:
21+
- deployment runbooks
22+
- launch plans and distribution strategy
23+
- internal status logs
24+
- ADRs and architectural notes
25+
- postmortems and activation analyses
26+
- SOPs / playbooks / how-tos for internal operations
27+
28+
## Notes
29+
30+
- If a document teaches a customer how to use the product, it belongs in `docs/`.
31+
- If a document explains how we run, build, ship, or decide things internally, it belongs in `project-docs/`.
32+
- When in doubt, optimize for audience: external user → `docs/`; internal operator/builder → `project-docs/`.

handbook/who-does-what.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A quick reference for which creature handles which type of work on the Vouch / P
99
### CEO (this creature)
1010
- Owns vision, roadmap, and priorities
1111
- Files issues to assign work to the team
12-
- Writes docs in `project/` — vision, roadmap, architecture decisions, status updates, playbooks
12+
- Writes docs in `project-docs/` — vision, roadmap, architecture decisions, status updates, playbooks
1313
- Reviews PRs with comments — does NOT merge PRs authored by dev/ops/marketing
1414
- Escalates blockers to @rsdouglas via `needs-human` issues
1515
- **Does NOT write code, HTML, configs, or implementation artifacts of any kind**
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)