Skip to content

Commit c8d1a9d

Browse files
Normalize docs-extractor audience tags; remove admin/stakeholder; strip tool invocations (#8717)
docs(extractor): normalize audience to type="user"; remove admin/stakeholder; strip tool invocation examples
1 parent 868117e commit c8d1a9d

File tree

8 files changed

+310
-2289
lines changed

8 files changed

+310
-2289
lines changed

.roo/rules-docs-extractor/1_extraction_workflow.xml

Lines changed: 85 additions & 283 deletions
Large diffs are not rendered by default.

.roo/rules-docs-extractor/2_documentation_patterns.xml

Lines changed: 40 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</overview>
55

66
<output_structure>
7-
<user_focused_template><![CDATA[
7+
<user_focused_template>
88
# [Feature Name]
99

1010
[Description of what the feature does and why a user should care.]
@@ -22,7 +22,7 @@
2222
- [Pain point 1]
2323
- [Pain point 2]
2424

25-
**With this feature]**: [Description of the new experience.]
25+
**With this feature**: [Description of the new experience.]
2626

2727
## How it Works
2828

@@ -58,9 +58,9 @@
5858
- [Answer.]
5959
- [Optional tip.]
6060

61-
]]></user_focused_template>
61+
</user_focused_template>
6262

63-
<comprehensive_template><![CDATA[
63+
<comprehensive_template>
6464
# [Feature Name] Technical Documentation
6565

6666
## Table of Contents
@@ -71,28 +71,27 @@
7171
5. Configuration
7272
6. User Guide
7373
7. Developer Guide
74-
8. Administrator Guide
75-
9. Security
76-
10. Performance
77-
11. Troubleshooting
78-
12. FAQ
79-
13. Changelog
80-
14. References
81-
82-
[This template remains available for generating detailed technical documentation.]
83-
]]></comprehensive_template>
74+
8. Security
75+
9. Performance
76+
10. Troubleshooting
77+
11. FAQ
78+
12. Changelog
79+
13. References
80+
81+
[Use this as an internal source-material outline for technical sections; not for final docs.]
82+
</comprehensive_template>
8483
</output_structure>
8584

8685
<documentation_patterns>
8786
<before_after>
88-
<template><![CDATA[
87+
<template>
8988
**Before**: Multiple, sequential file read requests:
9089
- "Read `src/app.js`?" → Approve
9190
- "Read `src/utils.js`?" → Approve
9291
- "Read `src/config.json`?" → Approve
9392

9493
**Now**: One request to read all related files.
95-
]]></template>
94+
</template>
9695
</before_after>
9796

9897
<visual_separator>
@@ -101,7 +100,7 @@
101100
</visual_separator>
102101

103102
<faq>
104-
<template><![CDATA[
103+
<template>
105104
## FAQ
106105

107106
**"Why disable this?"**
@@ -113,7 +112,7 @@
113112
- Roo reads approved files and works with what it has.
114113
- `.rooignore` files are excluded automatically.
115114
- Individual files can still be denied in the batch dialog.
116-
]]></template>
115+
</template>
117116
</faq>
118117

119118
<examples>
@@ -123,7 +122,7 @@
123122
</examples>
124123

125124
<troubleshooting>
126-
<template><![CDATA[
125+
<template>
127126
## Troubleshooting
128127

129128
**"Too many files requested"**
@@ -134,22 +133,22 @@
134133
- Ensure "Enable concurrent file reads" is on in settings.
135134
- Verify the file limit is set correctly (default: 100).
136135
- Some AI models may not support this feature.
137-
]]></template>
136+
</template>
138137
</troubleshooting>
139138

140139
<help>
141-
<template><![CDATA[
140+
<template>
142141
## Help
143142

144143
- See the [FAQ](#faq) for common issues.
145144
- Report problems on [GitHub Issues](https://github.com/RooCodeInc/Roo-Code/issues).
146145
- Include reproduction steps and error messages.
147-
]]></template>
146+
</template>
148147
</help>
149148
</documentation_patterns>
150149

151150
<audience_sections>
152-
<audience type="end_user">
151+
<audience type="user">
153152
<focus>
154153
<area>Tutorials</area>
155154
<area>Use cases</area>
@@ -179,85 +178,56 @@
179178
</style>
180179
</audience>
181180

182-
<audience type="administrator">
183-
<focus>
184-
<area>Deployment</area>
185-
<area>Monitoring</area>
186-
<area>Security hardening</area>
187-
<area>Backup and recovery</area>
188-
</focus>
189-
<style>
190-
<guideline>Operational focus</guideline>
191-
<guideline>CLI examples</guideline>
192-
<guideline>Automation opportunities</guideline>
193-
<guideline>Security and compliance</guideline>
194-
</style>
195-
</audience>
196-
197-
<audience type="stakeholder">
198-
<focus>
199-
<area>Business value</area>
200-
<area>Capabilities and limits</area>
201-
<area>Competitive advantages</area>
202-
<area>Risk assessment</area>
203-
</focus>
204-
<style>
205-
<guideline>Business language</guideline>
206-
<guideline>Metrics and KPIs</guideline>
207-
<guideline>Strategic benefits</guideline>
208-
<guideline>Executive summaries</guideline>
209-
</style>
210-
</audience>
211181
</audience_sections>
212182

213183
<metadata_patterns>
214184
<version_info>
215-
<template><![CDATA[
185+
<template>
216186
### Version Compatibility
217187
| Component | Min | Recommended | Max | Notes |
218188
|-----------|-----|-------------|-----|-------|
219189
| [Component] | [version] | [version] | [version] | [notes] |
220-
]]></template>
190+
</template>
221191
</version_info>
222192

223193
<deprecation_notice>
224-
<template><![CDATA[
194+
<template>
225195
> ⚠️ **Deprecated**
226196
>
227197
> Deprecated since: [vX.Y.Z] on [date]
228198
> Removal target: [vA.B.C]
229199
> Migration: See [migration guide](#migration).
230200
> Replacement: [new feature/method].
231-
]]></template>
201+
</template>
232202
</deprecation_notice>
233203

234204
<security_warning>
235-
<template><![CDATA[
205+
<template>
236206
> 🔒 **Security Warning**
237207
>
238208
> [Description of concern]
239209
> - **Risk**: [High/Medium/Low]
240210
> - **Affected**: [versions]
241211
> - **Mitigation**: [steps]
242212
> - **References**: [links]
243-
]]></template>
213+
</template>
244214
</security_warning>
245215

246216
<performance_note>
247-
<template><![CDATA[
217+
<template>
248218
> ⚡ **Performance Note**
249219
>
250220
> [Description of performance consideration]
251221
> - **Impact**: [metrics]
252222
> - **Optimization**: [approach]
253223
> - **Trade-offs**: [considerations]
254-
]]></template>
224+
</template>
255225
</performance_note>
256226
</metadata_patterns>
257227

258228
<code_documentation_patterns>
259229
<api_endpoint>
260-
<template><![CDATA[
230+
<template>
261231
### `[METHOD] /api/[path]`
262232

263233
**Description**: [What this endpoint does]
@@ -299,11 +269,11 @@ curl -X [METHOD] https://api.example.com/[path] \
299269
-H "Content-Type: application/json" \
300270
-d '{"field": "value"}'
301271
```
302-
]]></template>
272+
</template>
303273
</api_endpoint>
304274

305275
<function_documentation>
306-
<template><![CDATA[
276+
<template>
307277
### `functionName(parameters)`
308278

309279
**Purpose**: [What this function does]
@@ -326,11 +296,11 @@ const result = functionName(value1, value2);
326296
**Notes**:
327297
- [Important consideration 1]
328298
- [Important consideration 2]
329-
]]></template>
299+
</template>
330300
</function_documentation>
331301

332302
<configuration_option>
333-
<template><![CDATA[
303+
<template>
334304
### `CONFIG_NAME`
335305

336306
**Type**: `string | number | boolean`
@@ -352,7 +322,7 @@ config:
352322
```
353323

354324
**Impact**: [What changes when this is modified]
355-
]]></template>
325+
</template>
356326
</configuration_option>
357327
</code_documentation_patterns>
358328

@@ -368,20 +338,20 @@ config:
368338
</external_link>
369339

370340
<related_feature>
371-
<template><![CDATA[
341+
<template>
372342
> 📌 **Related Features**
373343
> - [Feature A](../feature-a/README.md): [How it relates]
374344
> - [Feature B](../feature-b/README.md): [How it relates]
375-
]]></template>
345+
</template>
376346
</related_feature>
377347

378348
<see_also>
379-
<template><![CDATA[
349+
<template>
380350
> 👉 **See Also**
381351
> - [Related Topic 1](#anchor1)
382352
> - [Related Topic 2](#anchor2)
383353
> - [External Resource](https://example.com)
384-
]]></template>
354+
</template>
385355
</see_also>
386356
</cross_reference_patterns>
387357
</documentation_patterns>

0 commit comments

Comments
 (0)