@doxbrix/doxloop 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/LICENSE +93 -0
  3. package/README.md +576 -0
  4. package/SECURITY.md +15 -0
  5. package/assets/brand/README.md +8 -0
  6. package/assets/brand/doxloop-favicon.png +0 -0
  7. package/assets/brand/doxloop-logo-dark.png +0 -0
  8. package/assets/brand/doxloop-logo-light.png +0 -0
  9. package/assets/doxbrix-preview.css +6672 -0
  10. package/dist/agents.d.ts +26 -0
  11. package/dist/agents.d.ts.map +1 -0
  12. package/dist/agents.js +258 -0
  13. package/dist/agents.js.map +1 -0
  14. package/dist/args.d.ts +8 -0
  15. package/dist/args.d.ts.map +1 -0
  16. package/dist/args.js +95 -0
  17. package/dist/args.js.map +1 -0
  18. package/dist/artifact-deploy.d.ts +8 -0
  19. package/dist/artifact-deploy.d.ts.map +1 -0
  20. package/dist/artifact-deploy.js +240 -0
  21. package/dist/artifact-deploy.js.map +1 -0
  22. package/dist/auth.d.ts +17 -0
  23. package/dist/auth.d.ts.map +1 -0
  24. package/dist/auth.js +245 -0
  25. package/dist/auth.js.map +1 -0
  26. package/dist/author.d.ts +30 -0
  27. package/dist/author.d.ts.map +1 -0
  28. package/dist/author.js +195 -0
  29. package/dist/author.js.map +1 -0
  30. package/dist/capture.d.ts +10 -0
  31. package/dist/capture.d.ts.map +1 -0
  32. package/dist/capture.js +299 -0
  33. package/dist/capture.js.map +1 -0
  34. package/dist/cli.d.ts +3 -0
  35. package/dist/cli.d.ts.map +1 -0
  36. package/dist/cli.js +558 -0
  37. package/dist/cli.js.map +1 -0
  38. package/dist/deploy.d.ts +22 -0
  39. package/dist/deploy.d.ts.map +1 -0
  40. package/dist/deploy.js +136 -0
  41. package/dist/deploy.js.map +1 -0
  42. package/dist/doctor.d.ts +18 -0
  43. package/dist/doctor.d.ts.map +1 -0
  44. package/dist/doctor.js +222 -0
  45. package/dist/doctor.js.map +1 -0
  46. package/dist/doxbrix-markdown.d.ts +20 -0
  47. package/dist/doxbrix-markdown.d.ts.map +1 -0
  48. package/dist/doxbrix-markdown.js +873 -0
  49. package/dist/doxbrix-markdown.js.map +1 -0
  50. package/dist/errors.d.ts +8 -0
  51. package/dist/errors.d.ts.map +1 -0
  52. package/dist/errors.js +15 -0
  53. package/dist/errors.js.map +1 -0
  54. package/dist/fs.d.ts +6 -0
  55. package/dist/fs.d.ts.map +1 -0
  56. package/dist/fs.js +77 -0
  57. package/dist/fs.js.map +1 -0
  58. package/dist/generator-api.d.ts +69 -0
  59. package/dist/generator-api.d.ts.map +1 -0
  60. package/dist/generator-api.js +6 -0
  61. package/dist/generator-api.js.map +1 -0
  62. package/dist/generator-manager.d.ts +13 -0
  63. package/dist/generator-manager.d.ts.map +1 -0
  64. package/dist/generator-manager.js +155 -0
  65. package/dist/generator-manager.js.map +1 -0
  66. package/dist/generator-runtime.d.ts +24 -0
  67. package/dist/generator-runtime.d.ts.map +1 -0
  68. package/dist/generator-runtime.js +265 -0
  69. package/dist/generator-runtime.js.map +1 -0
  70. package/dist/generators.d.ts +21 -0
  71. package/dist/generators.d.ts.map +1 -0
  72. package/dist/generators.js +202 -0
  73. package/dist/generators.js.map +1 -0
  74. package/dist/preview.d.ts +21 -0
  75. package/dist/preview.d.ts.map +1 -0
  76. package/dist/preview.js +691 -0
  77. package/dist/preview.js.map +1 -0
  78. package/dist/progress.d.ts +19 -0
  79. package/dist/progress.d.ts.map +1 -0
  80. package/dist/progress.js +70 -0
  81. package/dist/progress.js.map +1 -0
  82. package/dist/project.d.ts +37 -0
  83. package/dist/project.d.ts.map +1 -0
  84. package/dist/project.js +499 -0
  85. package/dist/project.js.map +1 -0
  86. package/dist/sync.d.ts +7 -0
  87. package/dist/sync.d.ts.map +1 -0
  88. package/dist/sync.js +221 -0
  89. package/dist/sync.js.map +1 -0
  90. package/dist/types.d.ts +141 -0
  91. package/dist/types.d.ts.map +1 -0
  92. package/dist/types.js +2 -0
  93. package/dist/types.js.map +1 -0
  94. package/dist/validation.d.ts +4 -0
  95. package/dist/validation.d.ts.map +1 -0
  96. package/dist/validation.js +478 -0
  97. package/dist/validation.js.map +1 -0
  98. package/dist/version.d.ts +3 -0
  99. package/dist/version.d.ts.map +1 -0
  100. package/dist/version.js +5 -0
  101. package/dist/version.js.map +1 -0
  102. package/docs/agent-compatibility.md +41 -0
  103. package/docs/ci-and-automation.md +56 -0
  104. package/docs/doxbrix-http-api.md +182 -0
  105. package/docs/generator-authoring.md +59 -0
  106. package/docs/generator-selection.md +25 -0
  107. package/docs/project-format.md +97 -0
  108. package/docs/security-model.md +90 -0
  109. package/docs/troubleshooting.md +103 -0
  110. package/package.json +87 -0
  111. package/skills/doxloop-authoring/SKILL.md +381 -0
  112. package/skills/doxloop-authoring/agents/openai.yaml +4 -0
  113. package/skills/doxloop-authoring/assets/screenshot-highlight.js +83 -0
  114. package/skills/doxloop-authoring/references/accessibility.md +54 -0
  115. package/skills/doxloop-authoring/references/audience-flavors.md +93 -0
  116. package/skills/doxloop-authoring/references/branding.md +50 -0
  117. package/skills/doxloop-authoring/references/documentation-types.md +236 -0
  118. package/skills/doxloop-authoring/references/domain-ai-ml.md +67 -0
  119. package/skills/doxloop-authoring/references/domain-api-platform.md +68 -0
  120. package/skills/doxloop-authoring/references/domain-cli-tool.md +65 -0
  121. package/skills/doxloop-authoring/references/domain-data-platform.md +65 -0
  122. package/skills/doxloop-authoring/references/domain-developer-library.md +63 -0
  123. package/skills/doxloop-authoring/references/domain-ecommerce.md +63 -0
  124. package/skills/doxloop-authoring/references/domain-infrastructure-devops.md +67 -0
  125. package/skills/doxloop-authoring/references/domain-payments-fintech.md +69 -0
  126. package/skills/doxloop-authoring/references/domain-saas.md +71 -0
  127. package/skills/doxloop-authoring/references/domain-security-identity.md +65 -0
  128. package/skills/doxloop-authoring/references/editorial-style.md +105 -0
  129. package/skills/doxloop-authoring/references/examples-and-evidence.md +71 -0
  130. package/skills/doxloop-authoring/references/navigation-architecture.md +152 -0
  131. package/skills/doxloop-authoring/references/project-format.md +119 -0
  132. package/skills/doxloop-authoring/references/quality.md +122 -0
  133. package/skills/doxloop-authoring/references/reference-sites.md +207 -0
  134. package/skills/doxloop-authoring/references/screenshots.md +251 -0
  135. package/skills/doxloop-authoring/references/template-routing.md +94 -0
  136. package/skills/doxloop-authoring/references/type-administrator-guide.md +59 -0
  137. package/skills/doxloop-authoring/references/type-api-reference.md +66 -0
  138. package/skills/doxloop-authoring/references/type-architecture-concepts.md +61 -0
  139. package/skills/doxloop-authoring/references/type-cli-manual.md +61 -0
  140. package/skills/doxloop-authoring/references/type-deployment-operations.md +64 -0
  141. package/skills/doxloop-authoring/references/type-developer-portal.md +69 -0
  142. package/skills/doxloop-authoring/references/type-getting-started.md +59 -0
  143. package/skills/doxloop-authoring/references/type-integration-guide.md +59 -0
  144. package/skills/doxloop-authoring/references/type-migration-release.md +66 -0
  145. package/skills/doxloop-authoring/references/type-sdk-guide.md +63 -0
  146. package/skills/doxloop-authoring/references/type-troubleshooting-kb.md +63 -0
  147. package/skills/doxloop-authoring/references/type-user-guide.md +59 -0
  148. package/skills/doxloop-doxbrix/SKILL.md +83 -0
  149. package/skills/doxloop-doxbrix/agents/openai.yaml +4 -0
  150. package/skills/doxloop-doxbrix/references/api-endpoints.md +128 -0
  151. package/skills/doxloop-doxbrix/references/components.md +137 -0
  152. package/skills/doxloop-doxbrix/references/manifest.md +117 -0
@@ -0,0 +1,251 @@
1
+ # Application guide screenshots
2
+
3
+ Use this workflow only for screenshots of the product being documented. The
4
+ existing `doxloop capture` command inspects external documentation design
5
+ references and is not part of this workflow.
6
+
7
+ ## Decide whether capture is enabled
8
+
9
+ Capture application screenshots when any of these conditions applies:
10
+
11
+ - the task prompt says screenshots are required because `--screenshots` was
12
+ supplied;
13
+ - the user explicitly asks to include, create, capture, or refresh screenshots;
14
+ - `.doxloop/project.json` sets `application.screenshots.policy` to `auto` and
15
+ the agreed page is a visible user-interface workflow.
16
+
17
+ Do not capture when the task prompt disables screenshots; when the project
18
+ policy is `off` and the task prompt does not explicitly require them; when the
19
+ request mentions screenshots only negatively or as an example; or when the page
20
+ has no meaningful visible application state. An explicit `--screenshots`
21
+ requirement overrides project policy for that run. Never add screenshots to API
22
+ or CLI procedures merely for decoration.
23
+
24
+ ## Use the user-managed application
25
+
26
+ Assume the user has already started and prepared the application. Never start,
27
+ restart, stop, seed, reset, or reconfigure it. Never run a project startup,
28
+ setup, database, or authentication command. Use `application.baseUrl` when it
29
+ is configured; otherwise use the application URL supplied by the user or
30
+ already open in the approved in-app browser. If no reachable application
31
+ surface is available, finish the text guide without broken image links and
32
+ report that screenshots could not be captured.
33
+
34
+ Capture only the agreed application origin and its required public assets.
35
+ Never use a real customer or production environment, change shared data, or
36
+ operate outside the workflow being documented.
37
+
38
+ ## Reuse in-app browser authentication
39
+
40
+ Keep authentication in the in-app browser controlled by Codex, Claude, or the
41
+ selected agent. Do not add authentication settings to `.doxloop/project.json`
42
+ and do not create login scripts, storage-state files, credential files, or
43
+ environment-variable requirements.
44
+
45
+ 1. Open the application in the approved in-app browser and inspect the visible
46
+ state.
47
+ 2. If an authenticated application page is already visible, reuse that session
48
+ and continue without mentioning login.
49
+ 3. If the application redirects to login, first allow the browser's existing
50
+ session or password-manager autofill to work. The agent may select a sign-in
51
+ control after autofill, but must never inspect, copy, reveal, or log an
52
+ autofilled value.
53
+ 4. If user interaction is required, keep the login page open and ask the user
54
+ once to complete login, MFA, SSO, passkey, or browser confirmation directly
55
+ in that browser. Never ask for a password, token, OTP, cookie, recovery code,
56
+ or secret in chat.
57
+ 5. After login, verify a stable authenticated state such as the expected page,
58
+ account menu, workspace name, or application heading before capture.
59
+ 6. Keep the same browser session and context for the entire capture manifest.
60
+ Do not clear cookies, local storage, cache, or site data and do not open the
61
+ workflow in an isolated browser context.
62
+ 7. If the session expires, preserve the current manifest row, return to the
63
+ login checkpoint once, verify authentication again, and resume that row
64
+ rather than restarting or taking screenshots of the login page.
65
+
66
+ Use a demo, test, or other non-production account with synthetic data. Treat
67
+ login and account-selection screens as private operational states: exclude
68
+ them from the guide unless the agreed reader task is specifically about login.
69
+
70
+ ## Plan the visual story
71
+
72
+ Finish and fact-check the ordered text procedure before operating the
73
+ application. Make every UI step atomic: one primary reader action followed by
74
+ one observable result. Do not capture while improvising the guide.
75
+
76
+ Create a capture manifest before taking the first image. Give every published
77
+ UI step a stable step ID, including steps that intentionally have no image:
78
+
79
+ | Step ID | Published action | Expected visible state | Capture? | Target | Filename | Alt text | Status |
80
+ | --- | --- | --- | --- | --- | --- | --- | --- | --- |
81
+ | 01 | Open **Team settings**. | Team settings page is visible. | yes | page heading | `01-team-settings.png` | Team settings page with the heading marked as step 1 | planned |
82
+ | 02 | Copy the workspace ID. | ID is copied; no durable visual change. | no | — | — | — | text-only |
83
+ | 03 | Select **Invite member**. | Invitation form is open. | yes | Invite member button | `03-invite-form.png` | Invitation form opened from the Invite member button marked as step 3 | planned |
84
+
85
+ The manifest is the source of truth for capture order, filenames, step marker
86
+ numbers, alt text, and placement. Never choose screenshots opportunistically
87
+ from whatever page happens to be open. Do not renumber captures to hide an
88
+ intentionally text-only step: the image prefix and visual marker must match the
89
+ published step number.
90
+
91
+ For each guide step, record:
92
+
93
+ 1. the reader action immediately before the image;
94
+ 2. the stable visible state that proves the action succeeded;
95
+ 3. the control or region that needs attention, if any;
96
+ 4. the image filename, alternative text, and optional caption.
97
+
98
+ When the user asks for a screenshot for every step, capture every step that has
99
+ a meaningful visible UI state. Mark non-UI steps and actions with no durable
100
+ visible change as `text-only` in the manifest and explain that decision in the
101
+ completion summary. Otherwise capture only when an image reduces ambiguity or
102
+ confirms an important state. Keep the application chrome and nearby labels when
103
+ they help readers orient themselves. Prefer a viewport screenshot or a
104
+ carefully cropped stable region; avoid very tall full-page screenshots for task
105
+ steps.
106
+
107
+ ## Operate and verify the workflow
108
+
109
+ Prefer stable accessible roles, labels, visible text, and product test IDs over
110
+ fragile CSS structure. Reuse verified Playwright, Cypress, or other UI tests as
111
+ workflow evidence when available, but do not modify or submit destructive
112
+ production data. Process the manifest strictly from the lowest step ID to the
113
+ highest. For each planned image:
114
+
115
+ 1. reset or establish the expected fixture state;
116
+ 2. perform the documented actions in their published order;
117
+ 3. wait for the expected visible outcome, not an arbitrary delay alone;
118
+ 4. dismiss only transient UI that a normal reader would not see;
119
+ 5. inspect the viewport for secrets, personal data, unstable timestamps,
120
+ unrelated notifications, and accidental browser content;
121
+ 6. add contextual highlighting when it materially helps;
122
+ 7. capture the image to its manifest filename;
123
+ 8. open the saved file and verify that it is the expected step, has the correct
124
+ marker, is legible, contains no sensitive or transient content, and is not a
125
+ duplicate of another step;
126
+ 9. mark the manifest row `verified` only after that inspection, then remove the
127
+ overlay and continue.
128
+
129
+ If a capture is wrong, replace that file immediately and repeat the same
130
+ manifest row. Do not continue and plan to sort screenshots out later. Do not
131
+ reuse one screenshot for multiple steps unless those steps intentionally refer
132
+ to exactly the same visible state and the prose makes that explicit.
133
+
134
+ If browser automation is unavailable or the application cannot be reached,
135
+ finish a complete text guide, do not create placeholder images or broken image
136
+ links, and report the capture limitation.
137
+
138
+ ## Highlight the relevant context
139
+
140
+ When `application.screenshots.highlight` is not `false`, highlight the control
141
+ or result a reader should notice. Use a temporary browser overlay rather than
142
+ editing product source or permanently changing application styles:
143
+
144
+ - draw a 3 px high-contrast ring with 4–6 px clearance around the target;
145
+ - add a small numbered marker matching the corresponding guide step;
146
+ - optionally dim the rest of the viewport by no more than 18 percent;
147
+ - keep the target, its label, validation message, and surrounding orientation
148
+ visible;
149
+ - never use color alone: the numbered marker and nearby prose must identify the
150
+ target;
151
+ - remove the overlay before continuing to the next application action.
152
+
153
+ When the browser supports script evaluation, inject the packaged
154
+ [highlight helper](../assets/screenshot-highlight.js), call
155
+ `__doxloopScreenshotHighlight({ selector, step, dim })` immediately before the
156
+ screenshot, and call `__doxloopRemoveScreenshotHighlight()` immediately after.
157
+ Choose `selector` from a verified stable test ID, accessible label relationship,
158
+ or other stable product evidence. The helper returns the measured target bounds
159
+ for the capture record and never mutates product source.
160
+
161
+ The ring and marker should be baked into the PNG so they work in every
162
+ documentation generator. Do not draw arrows or labels over interactive text,
163
+ form values, error details, or other information the reader needs.
164
+
165
+ ## Store and embed screenshots
166
+
167
+ Follow the selected generator skill for its native public asset directory and
168
+ image syntax. Group images under a stable guide-specific directory and use
169
+ ordered, descriptive filenames, for example:
170
+
171
+ ```text
172
+ assets/guides/invite-team-member/
173
+ 01-team-settings.png
174
+ 02-invite-form.png
175
+ 03-invitation-sent.png
176
+ ```
177
+
178
+ Use these default committed locations unless the existing project has an
179
+ established equivalent:
180
+
181
+ | Generator | Screenshot directory | Public/reference prefix |
182
+ | --- | --- | --- |
183
+ | Doxbrix | `<contentDir>/assets/guides/<guide>/` | `/assets/guides/<guide>/` |
184
+ | Docusaurus | `static/img/guides/<guide>/` | `/img/guides/<guide>/` |
185
+ | MkDocs | `docs/assets/guides/<guide>/` | page-relative `assets/guides/` |
186
+ | Sphinx | `<contentDir>/_static/guides/<guide>/` | `/_static/guides/<guide>/` |
187
+ | Hugo | `static/images/guides/<guide>/` | `/images/guides/<guide>/` |
188
+ | VitePress | `docs/public/images/guides/<guide>/` | `/images/guides/<guide>/` |
189
+ | Markdoc | `assets/guides/<guide>/` | `/assets/guides/<guide>/` |
190
+ | Nextra | `public/images/guides/<guide>/` | `/images/guides/<guide>/` |
191
+ | Starlight | `public/images/guides/<guide>/` | `/images/guides/<guide>/` |
192
+ | Jekyll | `assets/images/guides/<guide>/` | `relative_url` from `/assets/images/guides/<guide>/` |
193
+ | Static HTML | `site/assets/guides/<guide>/` | `/assets/guides/<guide>/` |
194
+
195
+ Respect any configured base path when the generator requires relative or
196
+ base-aware URLs. Verify the final built output contains each image; source-file
197
+ existence alone is not sufficient.
198
+
199
+ Guide screenshots are committed documentation assets. Never put them under
200
+ `.doxloop/cache/reference/`. Embed each verified image before capturing the
201
+ next step. Insert it inside the same ordered-list item, immediately after the
202
+ instruction or expected-result sentence that the image proves. Do not collect
203
+ step screenshots at the beginning or end of the guide, place an image between
204
+ two unrelated steps, or let Markdown indentation terminate the ordered list.
205
+ Add concise alternative text describing the useful visible state, not phrases
206
+ such as "screenshot of". Use a caption for orientation or consequence that is
207
+ not already obvious from the prose. Keep all essential instructions and values
208
+ in text outside the image.
209
+
210
+ For Doxbrix, prefer a captioned frame:
211
+
212
+ ```mdx
213
+ <Frame caption="The highlighted Invite member control opens the invitation form.">
214
+
215
+ ![Team settings with the Invite member control marked as step 1](/assets/guides/invite-team-member/01-team-settings.png)
216
+
217
+ </Frame>
218
+ ```
219
+
220
+ Use native caption or figure syntax supplied by other generators. Plain
221
+ Markdown images are the portable fallback.
222
+
223
+ ## Run the screenshot completeness gate
224
+
225
+ Do not finish a screenshot-enabled guide until all of these checks pass:
226
+
227
+ 1. Compare the final ordered procedure with the manifest row by row.
228
+ 2. Confirm every published UI step has exactly one `verified` image or an
229
+ explicit `text-only` reason.
230
+ 3. Confirm every verified manifest filename exists exactly once in the guide
231
+ and immediately follows its matching step.
232
+ 4. Confirm the filename prefix, highlighted marker, prose step number, visible
233
+ state, and alt text all refer to the same step.
234
+ 5. Confirm there are no unreferenced captures, broken paths, duplicate images,
235
+ stale screenshots, or screenshot links outside the guide-specific folder.
236
+ 6. Build the selected generator, then inspect the rendered guide from top to
237
+ bottom at desktop and narrow widths. Verify list numbering, image order,
238
+ cropping, legibility, captions, and the association between each step and
239
+ image.
240
+
241
+ Any mismatch is a blocking defect. Fix the procedure, manifest, capture, or
242
+ placement and rerun the entire gate; do not report the guide as complete.
243
+
244
+ ## Refresh without churn
245
+
246
+ During update, recapture only when the documented workflow, visible label,
247
+ layout, theme, or expected outcome changed, or when the user explicitly asks.
248
+ Preserve filenames when the semantic step is unchanged so links and review
249
+ history remain stable. Remove an old image only after all page references to it
250
+ are removed. Run `doxloop test` and the generator build to catch missing assets,
251
+ then review the rendered guide at desktop and narrow widths.
@@ -0,0 +1,94 @@
1
+ # Expert template routing
2
+
3
+ Use this reference after initial product discovery and before proposing coverage.
4
+ Templates are investigation and authoring playbooks, never evidence about the
5
+ configured product.
6
+
7
+ ## Compose the expertise profile
8
+
9
+ Build one profile from:
10
+
11
+ 1. one primary domain template when evidence supports a meaningful match;
12
+ 2. at most one adjacent domain template when a distinct public capability needs
13
+ it;
14
+ 3. every documentation-type template needed for the agreed reader outcomes;
15
+ 4. audience flavor applied inside each selected domain/type combination; and
16
+ 5. the persisted brief and current user request.
17
+
18
+ Do not treat audience as an independent documentation template. Audience changes
19
+ depth, vocabulary, prerequisites, examples, risk emphasis, and navigation order
20
+ inside a domain/type plan. When two audiences have materially different jobs,
21
+ create separate journeys or sections instead of averaging them into vague copy.
22
+ If no specialized domain matches, use the product evidence and relevant
23
+ documentation-type playbooks without forcing a domain label.
24
+
25
+ ## Select without forcing a preset
26
+
27
+ - Infer templates from configured source evidence, existing pages, the persisted
28
+ brief, and the user's words.
29
+ - Do not ask the user to choose a template or know a template identifier.
30
+ - When the match is clear, apply it and state the selected expertise profile in
31
+ the discovery summary.
32
+ - When two choices would materially change scope, audience, or outcomes, include
33
+ that decision in the single consolidated consultation already required for
34
+ create work.
35
+ - A named template in the request is a strong intent signal, not permission to
36
+ invent unsupported capabilities.
37
+ - Preserve selected outcomes and audience decisions in the documentation brief;
38
+ do not persist template identifiers as permanent requirements.
39
+
40
+ ## Domain routing signals
41
+
42
+ | Primary domain | Strong evidence signals |
43
+ | --- | --- |
44
+ | SaaS application | workspaces or tenants, memberships, roles, subscriptions, browser workflows |
45
+ | API platform | public routes or specifications, credentials, request/response contracts, quotas |
46
+ | Developer library | package exports, public types, runtime requirements, library contract tests |
47
+ | CLI tool | command parser, help output, flags, stdout/stderr, exit contracts |
48
+ | Payments and fintech | payment intents or charges, settlement, refunds, disputes, signed events |
49
+ | E-commerce | catalog, cart, order, inventory, fulfillment, returns |
50
+ | AI and machine learning | model or agent interfaces, inference, prompts, evaluations, model limits |
51
+ | Data platform | connectors, schemas, pipelines, transformations, lineage, data quality |
52
+ | Security and identity | identities, authentication factors, authorization policy, audit events |
53
+ | Infrastructure and DevOps | provisioning, environments, deployment, health, observability, recovery |
54
+
55
+ Choose the most specific supported domain. For example, a payment API uses the
56
+ payments domain as primary and the API-platform domain as adjacent. A SaaS
57
+ product with ordinary REST endpoints remains SaaS-primary unless developers are
58
+ the confirmed primary readers and the API is the main product.
59
+
60
+ ## Documentation-type routing signals
61
+
62
+ | Type playbook | Select when readers need to |
63
+ | --- | --- |
64
+ | Getting started | reach a first meaningful result from a clean state |
65
+ | Developer portal | integrate across onboarding, concepts, tasks, and reference |
66
+ | API reference | look up a supported programmatic contract consistently |
67
+ | SDK guide | install and use a language library correctly |
68
+ | CLI manual | discover and automate supported commands and options |
69
+ | User guide | complete recurring product tasks through a UI or user-facing workflow |
70
+ | Administrator guide | configure shared settings, identities, roles, policy, or lifecycle |
71
+ | Integration guide | connect the product to another bounded system |
72
+ | Deployment and operations | deploy, observe, maintain, upgrade, and recover a running system |
73
+ | Troubleshooting knowledge base | diagnose observable symptoms and apply verified recovery |
74
+ | Migration and release | move between versions or act on release-visible change |
75
+ | Architecture and concepts | make correct decisions using stable public mental models |
76
+
77
+ Read only the selected domain and documentation-type files. Do not load the
78
+ whole catalog merely because it exists.
79
+
80
+ ## Resolve overlap
81
+
82
+ - Domain templates own domain risk, lifecycle, state, and practitioner concerns.
83
+ - Type templates own reader journey, page architecture, procedural contract,
84
+ and reference completeness.
85
+ - The audience-flavor reference owns adaptation within the selected combination.
86
+ - The navigation-architecture reference owns the common site frame, type-block
87
+ composition, domain overlays, audience ordering, and navigation quality gate.
88
+ - The generator skill owns syntax, components, navigation files, and rendering.
89
+ - Product evidence overrides every template suggestion.
90
+
91
+ If a suggested topic has no reader need or supporting evidence, omit it. If
92
+ source evidence reveals a material capability not named by a template, document
93
+ it according to the agreed scope rather than constraining coverage to the
94
+ template.
@@ -0,0 +1,59 @@
1
+ # Administrator-guide playbook
2
+
3
+ Use when readers configure shared scope, identities, access, policy, lifecycle,
4
+ or organization-wide behavior.
5
+
6
+ ## Separate authority from ordinary use
7
+
8
+ Define administrator roles, delegated authority, managed scope, and boundaries
9
+ before procedures. Separate initial setup, routine administration, governance,
10
+ security, billing, lifecycle, and recovery when the product supports them.
11
+
12
+ ## Expected coverage
13
+
14
+ - administrative access and safe first setup;
15
+ - organization, workspace, project, or environment lifecycle;
16
+ - member onboarding, offboarding, ownership, roles, and permissions;
17
+ - authentication, federation, credentials, and session policy;
18
+ - defaults, inheritance, precedence, propagation, and exceptions;
19
+ - shared feature configuration and integrations;
20
+ - plans, quotas, billing, or licensing when administrator-visible;
21
+ - audit, reporting, export, retention, deletion, and support evidence;
22
+ - change verification, rollback, lockout recovery, and escalation.
23
+
24
+ For each action, state the required role, affected scope, prerequisites,
25
+ propagation or restart behavior, consequences, verification, and supported
26
+ reversal. Put destructive or organization-wide effects before the final action.
27
+
28
+ ## Governance lens
29
+
30
+ Explain how administrators can review effective configuration, detect drift or
31
+ exceptions, transfer ownership, and prove a change took effect when those
32
+ capabilities exist. Do not convert generic recommendations into product guarantees.
33
+
34
+ ## Standard navigation
35
+
36
+ Promote `Administration` only when it is a substantial independent surface. Use:
37
+
38
+ ```text
39
+ Administrator overview
40
+ Initial setup
41
+ Users and access
42
+ Authentication
43
+ Security and policy
44
+ Product configuration
45
+ Integrations
46
+ Plans and usage
47
+ Data management
48
+ Administration operations
49
+ Troubleshooting
50
+ ```
51
+
52
+ Order setup, lockout prevention, and access control before lower-risk feature
53
+ settings. Omit SSO, billing, audit, or retention destinations without evidence.
54
+
55
+ ## Senior quality gate
56
+
57
+ An administrator can establish a safe baseline, delegate access, predict the
58
+ scope of a change, verify effective state, avoid lockout, and recover from
59
+ evidenced configuration failures without relying on hidden superuser knowledge.
@@ -0,0 +1,66 @@
1
+ # API-reference playbook
2
+
3
+ Use for a supported public programmatic contract. Pair it with getting-started
4
+ and task guidance when readers must learn or combine operations.
5
+
6
+ ## Declare the reference boundary
7
+
8
+ Name the API, version or stability boundary, environment, and operations included.
9
+ Exclude internal, experimental, generated-only, or unreachable interfaces unless
10
+ the product explicitly supports them. Use the generator's native API-reference
11
+ contract when available.
12
+
13
+ ## Cover every operation consistently
14
+
15
+ Document, when supported:
16
+
17
+ - method or operation name, path, purpose, and authorization;
18
+ - content types, headers, path, query, cookie, and body parameters;
19
+ - type, format, requiredness, default, allowed values, constraints, and semantics;
20
+ - request examples using safe realistic data;
21
+ - success status, headers, body schema, field meaning, and example;
22
+ - error statuses, error body, cause, retryability, and reader action;
23
+ - pagination, filtering, sorting, expansion, idempotency, and concurrency behavior;
24
+ - permissions, limits, side effects, asynchronous state, and related events.
25
+
26
+ Document reusable schemas once when that improves consistency, but keep operation-
27
+ specific meaning next to the operation. Distinguish absent, null, empty, zero,
28
+ and default values when the contract does.
29
+
30
+ ## Reconcile evidence
31
+
32
+ Compare specifications, public route types, validation schemas, tests, and
33
+ implementation. Report contradictions rather than silently choosing convenient
34
+ values. A generated specification may establish shape but not operational
35
+ guarantees; tests may demonstrate cases without defining the entire contract.
36
+
37
+ ## Standard navigation
38
+
39
+ Promote `API reference` to top navigation only when it is a substantial primary
40
+ surface. Use this left-navigation block:
41
+
42
+ ```text
43
+ API overview
44
+ Base URLs and environments
45
+ Authentication
46
+ Request conventions
47
+ Response conventions
48
+ Versioning
49
+ Resources
50
+ Resource groups and operations
51
+ Data models
52
+ Common behavior
53
+ Pagination, filtering, and sorting
54
+ Idempotency and concurrency
55
+ Limits
56
+ Errors
57
+ Events and webhooks
58
+ ```
59
+
60
+ Group operations by reader-visible resources, not implementation controllers.
61
+
62
+ ## Senior quality gate
63
+
64
+ Coverage is uniform across the declared public surface; required and optional
65
+ values are unambiguous; examples conform to schemas; errors lead to a supported
66
+ action; and no material contract fact must be inferred from a sample alone.
@@ -0,0 +1,61 @@
1
+ # Architecture-and-concepts playbook
2
+
3
+ Use when readers need a stable public mental model to make correct integration,
4
+ administration, deployment, or operational decisions. Do not expose internals
5
+ merely because source makes them visible.
6
+
7
+ ## Choose concepts with consequences
8
+
9
+ Document a concept only when misunderstanding it changes reader action or
10
+ outcome. Explain:
11
+
12
+ - the problem or decision the concept addresses;
13
+ - public components, actors, resources, and trust boundaries;
14
+ - relationships, ownership, cardinality, scope, and lifecycle;
15
+ - data or control flow and asynchronous boundaries;
16
+ - invariants, constraints, failure domains, and observable states;
17
+ - alternatives and tradeoffs supported by evidence;
18
+ - tasks and reference where the reader applies the model.
19
+
20
+ Use one term for each concept and align it with public interfaces. Prefer a
21
+ small diagram plus equivalent prose when several components or state transitions
22
+ interact. Label conceptual diagrams and avoid implying undocumented topology,
23
+ scale, or security properties.
24
+
25
+ ## Reader relevance
26
+
27
+ Adapt the boundary: developers need contract and lifecycle; administrators need
28
+ scope and authority; operators need dependencies and failure domains; evaluators
29
+ need capability and operating model. Keep internal implementation and repository
30
+ structure out unless maintainers are the confirmed readers.
31
+
32
+ ## Standard navigation
33
+
34
+ Keep concepts under Documentation unless Architecture is a major reader surface:
35
+
36
+ ```text
37
+ System overview
38
+ Core concepts
39
+ Primary resources
40
+ Relationships and ownership
41
+ Lifecycle
42
+ Architecture
43
+ Public components
44
+ Data and control flow
45
+ Asynchronous boundaries
46
+ Security model
47
+ Behavior and consistency
48
+ Deployment models
49
+ Design decisions and tradeoffs
50
+ Limitations
51
+ Glossary
52
+ ```
53
+
54
+ Order concepts by dependency. Never mirror source packages or internal service
55
+ names unless maintainers are the confirmed readers.
56
+
57
+ ## Senior quality gate
58
+
59
+ After reading, the intended reader can predict important observable behavior,
60
+ choose between supported approaches, and understand the consequence of a
61
+ boundary or lifecycle state without memorizing implementation details.
@@ -0,0 +1,61 @@
1
+ # CLI-manual playbook
2
+
3
+ Use when readers need both task-oriented command guidance and consistent lookup
4
+ for a command hierarchy.
5
+
6
+ ## Architect the manual
7
+
8
+ Provide installation and first success, then group tasks by reader outcome and
9
+ reference by command hierarchy. Put global concepts—configuration, profiles,
10
+ authentication, output formats, environment variables, and exit behavior—in
11
+ shared pages when they apply across commands.
12
+
13
+ ## Command contract
14
+
15
+ For every supported command, document:
16
+
17
+ - syntax and purpose;
18
+ - positional arguments and accepted forms;
19
+ - local and inherited options, defaults, repeatability, and mutual exclusions;
20
+ - config and environment precedence;
21
+ - input sources and supported formats;
22
+ - stdout, stderr, machine-readable output, and exit status;
23
+ - prompts, TTY or non-interactive behavior, side effects, and confirmation;
24
+ - complete examples and consequential limitations.
25
+
26
+ Keep aliases and deprecated commands clearly labeled. Avoid repeating the same
27
+ global option details under every command unless the generator cannot provide a
28
+ usable shared reference.
29
+
30
+ ## Automation lens
31
+
32
+ Show safe quoting, deterministic selection of context or profile, structured
33
+ output processing, prompt suppression, secret handling, exit checking, and dry
34
+ run where supported. Separate shell-specific examples or declare the shell.
35
+
36
+ ## Standard navigation
37
+
38
+ Promote `Command reference` for a command-heavy product. Use this block:
39
+
40
+ ```text
41
+ CLI overview
42
+ Getting started
43
+ Common workflows
44
+ Configuration
45
+ Command reference
46
+ Global options
47
+ Command groups
48
+ Input and output
49
+ Automation
50
+ Troubleshooting
51
+ Upgrade the CLI
52
+ Release notes
53
+ ```
54
+
55
+ Order commands by hierarchy inside reference and by reader outcome inside guides.
56
+
57
+ ## Senior quality gate
58
+
59
+ The manual matches actual help and parser behavior, but adds the context help
60
+ cannot provide: prerequisites, side effects, output meaning, failure handling,
61
+ automation safety, and task-oriented sequences.
@@ -0,0 +1,64 @@
1
+ # Deployment-and-operations playbook
2
+
3
+ Use when readers own installation, production configuration, deployment,
4
+ observability, routine maintenance, upgrade, backup, or recovery.
5
+
6
+ ## Structure by operating lifecycle
7
+
8
+ Organize evidence-backed content as:
9
+
10
+ 1. supported architecture and prerequisites;
11
+ 2. reference deployment or installation;
12
+ 3. production configuration and secrets;
13
+ 4. health verification and observability;
14
+ 5. scaling and routine operations;
15
+ 6. change, upgrade, and rollback;
16
+ 7. backup, restore, and disaster recovery;
17
+ 8. incident diagnostics and escalation.
18
+
19
+ Do not publish a production checklist made of generic advice. Every requirement
20
+ must connect to supported product behavior, a public dependency, or a clearly
21
+ labeled organizational decision.
22
+
23
+ ## Procedure contract
24
+
25
+ Every operational change includes scope, authority, dependencies, prechecks,
26
+ backup or rollback prerequisites, explicit targets, ordered actions, expected
27
+ signals, abort conditions, supported rollback, post-change verification, and
28
+ cleanup. Distinguish control-plane success from workload health.
29
+
30
+ ## Configuration and signals
31
+
32
+ Reference pages cover keys, types, defaults, precedence, reload behavior,
33
+ sensitivity, and version support. Signal pages explain what health, logs,
34
+ metrics, traces, and events mean and which reader action follows—without
35
+ inventing thresholds.
36
+
37
+ ## Standard navigation
38
+
39
+ Promote `Operations` only for operator-focused sites. Otherwise place this block
40
+ inside Documentation:
41
+
42
+ ```text
43
+ Operations overview
44
+ Architecture and deployment models
45
+ Plan the deployment
46
+ Install and deploy
47
+ Configuration reference
48
+ Security and secrets
49
+ Observability
50
+ Routine operations
51
+ Scaling and capacity
52
+ Backup and recovery
53
+ Upgrade and rollback
54
+ Incident response
55
+ Troubleshooting
56
+ ```
57
+
58
+ Order prechecks and health verification before routine change or recovery.
59
+
60
+ ## Senior quality gate
61
+
62
+ An operator can deploy the supported system, verify real readiness, manage
63
+ configuration and secrets, perform routine change, observe failure, and execute
64
+ supported rollback or recovery with a bounded blast radius.