Documentation Plan¶
This is a template. Replace every bracketed placeholder. This file itself establishes no policy.
Customer-Facing Documentation Inventory¶
| Doc Item | Format | Purpose | Owner | Ships Where |
|---|---|---|---|---|
| In-workbook instructions tab | Excel tab | [orient the user, explain the workflow] | [role] | Inside the workbook |
| Quick-start PDF guide | [get a new customer to first value fast] | [role] | Marketplace delivery / download bundle | |
| Full user guide | PDF or in-tab | [reference documentation for all features] | [role] | Download bundle |
| FAQ | [see support/README.md] | [answer recurring support questions] | [role] | support/ |
| Video walkthrough (if any) | [video link] | [demonstrate usage] | [role] | Marketplace listing / download bundle |
Documentation Principles for This Product¶
- [State any product-specific documentation needs beyond the venture default — e.g. extra care needed for calculation transparency in a financial product]
- Instructions must match the actual shipped feature set — update this plan and the
in-product documentation together whenever
feature-inventory.mdchanges.
Open Items¶
- [Anything not yet decided about documentation approach]
This is a template. Replace bracketed placeholders. This file itself establishes no policy.