@claudetools/tools 0.6.0 → 0.7.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.
|
@@ -127,6 +127,25 @@ export function buildOrchestratorPrompt(params) {
|
|
|
127
127
|
4. Effort estimate (xs/s/m/l/xl): Based on complexity
|
|
128
128
|
</task_structure>
|
|
129
129
|
|
|
130
|
+
<documentation_standards priority="MANDATORY">
|
|
131
|
+
When creating plans, research, or documentation:
|
|
132
|
+
|
|
133
|
+
DIRECTORY STRUCTURE:
|
|
134
|
+
- docs/ → Project documentation
|
|
135
|
+
- docs/research/ → Research and analysis
|
|
136
|
+
- docs/decisions/ → Architecture Decision Records
|
|
137
|
+
|
|
138
|
+
NAMING CONVENTIONS:
|
|
139
|
+
- lowercase-with-hyphens.md (NEVER underscores or spaces)
|
|
140
|
+
- Date prefix for temporal docs: YYYY-MM-DD-topic.md
|
|
141
|
+
- Example: docs/research/2025-12-05-auth-comparison.md
|
|
142
|
+
|
|
143
|
+
ANTI-PATTERNS (NEVER DO):
|
|
144
|
+
- PLAN.md, NOTES.md, TODO.md in project root
|
|
145
|
+
- SCREAMING_CASE_FILENAMES.md
|
|
146
|
+
- Random .md files scattered in src/ or root
|
|
147
|
+
</documentation_standards>
|
|
148
|
+
|
|
130
149
|
<entity_dsl_format>
|
|
131
150
|
When defining data models, use Entity DSL:
|
|
132
151
|
|
|
@@ -131,6 +131,38 @@ function buildStandardsSection() {
|
|
|
131
131
|
- Include file paths with line numbers in references
|
|
132
132
|
</formatting>
|
|
133
133
|
|
|
134
|
+
<documentation_files priority="MANDATORY">
|
|
135
|
+
NEVER create .md files in random locations. Follow these rules:
|
|
136
|
+
|
|
137
|
+
DIRECTORY STRUCTURE:
|
|
138
|
+
- docs/ → Project documentation, guides, specs
|
|
139
|
+
- docs/research/ → Research notes, analysis, investigations
|
|
140
|
+
- docs/decisions/ → Architecture Decision Records (ADRs)
|
|
141
|
+
- CHANGELOG.md → Only in project root
|
|
142
|
+
- README.md → Only in project root or package roots
|
|
143
|
+
|
|
144
|
+
NAMING CONVENTIONS:
|
|
145
|
+
- Use lowercase with hyphens: user-authentication-guide.md
|
|
146
|
+
- NEVER use spaces or underscores in filenames
|
|
147
|
+
- Include date prefix for time-sensitive docs: YYYY-MM-DD-topic.md
|
|
148
|
+
Example: 2025-12-05-api-migration-plan.md
|
|
149
|
+
- Research docs: YYYY-MM-DD-research-topic.md
|
|
150
|
+
- Decision records: NNNN-decision-title.md (e.g., 0001-use-jwt-auth.md)
|
|
151
|
+
|
|
152
|
+
ANTI-PATTERNS (NEVER DO):
|
|
153
|
+
- Creating PLAN.md, NOTES.md, TODO.md in project root
|
|
154
|
+
- Random capitalised filenames like IMPLEMENTATION_GUIDE.md
|
|
155
|
+
- Nested docs in src/ or lib/ directories
|
|
156
|
+
- Multiple README files outside package roots
|
|
157
|
+
- Temporary docs without dates (impossible to clean up later)
|
|
158
|
+
|
|
159
|
+
BEFORE CREATING ANY .md FILE:
|
|
160
|
+
1. Check if docs/ directory exists - create if needed
|
|
161
|
+
2. Determine correct subdirectory (research/, decisions/, etc.)
|
|
162
|
+
3. Use proper naming convention with date if temporal
|
|
163
|
+
4. Ask user if uncertain about placement
|
|
164
|
+
</documentation_files>
|
|
165
|
+
|
|
134
166
|
<completion_summary>
|
|
135
167
|
When calling task_complete, include:
|
|
136
168
|
- Implementation: What you built/changed
|