@laitszkin/apollo-toolkit 3.8.2 → 3.8.4
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.
- package/CHANGELOG.md +13 -0
- package/align-project-documents/SKILL.md +136 -130
- package/align-project-documents/agents/openai.yaml +2 -2
- package/align-project-documents/references/templates/standardized-docs-template.md +119 -0
- package/analyse-app-logs/scripts/__pycache__/filter_logs_by_time.cpython-312.pyc +0 -0
- package/analyse-app-logs/scripts/__pycache__/log_cli_utils.cpython-312.pyc +0 -0
- package/analyse-app-logs/scripts/__pycache__/search_logs.cpython-312.pyc +0 -0
- package/archive-specs/README.md +12 -25
- package/archive-specs/SKILL.md +24 -47
- package/archive-specs/agents/openai.yaml +2 -2
- package/archive-specs/references/templates/architecture.md +13 -21
- package/archive-specs/references/templates/docs-index.md +24 -24
- package/archive-specs/references/templates/features.md +18 -18
- package/archive-specs/references/templates/principles.md +28 -0
- package/archive-specs/references/templates/readme.md +4 -13
- package/docs-to-voice/scripts/__pycache__/docs_to_voice.cpython-312.pyc +0 -0
- package/generate-spec/SKILL.md +10 -12
- package/generate-spec/references/templates/checklist.md +33 -88
- package/generate-spec/scripts/__pycache__/create-specscpython-312.pyc +0 -0
- package/katex/scripts/__pycache__/render_katex.cpython-312.pyc +0 -0
- package/maintain-project-constraints/SKILL.md +90 -88
- package/maintain-project-constraints/agents/openai.yaml +2 -2
- package/open-github-issue/scripts/__pycache__/open_github_issue.cpython-312.pyc +0 -0
- package/package.json +1 -1
- package/read-github-issue/scripts/__pycache__/find_issues.cpython-312.pyc +0 -0
- package/read-github-issue/scripts/__pycache__/read_issue.cpython-312.pyc +0 -0
- package/resolve-review-comments/scripts/__pycache__/review_threads.cpython-312.pyc +0 -0
- package/text-to-short-video/scripts/__pycache__/enforce_video_aspect_ratio.cpython-312.pyc +0 -0
- package/align-project-documents/references/templates/category-based-project-docs-template.md +0 -170
- package/archive-specs/references/templates/configuration.md +0 -29
- package/archive-specs/references/templates/developer-guide.md +0 -33
- package/archive-specs/references/templates/getting-started.md +0 -38
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: maintain-project-constraints
|
|
3
|
-
description:
|
|
3
|
+
description: Create and maintain AGENTS.md/CLAUDE.md with the project's macro business goals, common development commands, and an index of all standardized project documentation under docs/. Use when AGENTS.md/CLAUDE.md is missing or may be outdated.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Maintain Project Constraints
|
|
@@ -14,130 +14,132 @@ description: Automatically create and maintain AGENTS.md/CLAUDE.md so it stays a
|
|
|
14
14
|
|
|
15
15
|
## Standards
|
|
16
16
|
|
|
17
|
-
- Evidence: Infer
|
|
18
|
-
- Execution:
|
|
19
|
-
- Quality:
|
|
20
|
-
- Output: Maintain a concise root-level `AGENTS.md
|
|
17
|
+
- Evidence: Infer project business goals and common commands from current code, configuration, and existing project documentation — not assumptions.
|
|
18
|
+
- Execution: Read the entire codebase or existing project docs before writing; create or update only after building a concrete inventory.
|
|
19
|
+
- Quality: Remove stale commands, paths, and references; keep AGENTS.md/CLAUDE.md focused on the three required sections only.
|
|
20
|
+
- Output: Maintain a concise root-level `AGENTS.md`/`CLAUDE.md` with common development commands, macro business goals, and a project documentation index.
|
|
21
21
|
|
|
22
22
|
## Goal
|
|
23
23
|
|
|
24
|
-
Keep `AGENTS.md
|
|
24
|
+
Keep `AGENTS.md`/`CLAUDE.md` accurate and synchronized with the current state of the repository, focused on helping agents understand the project's purpose, navigate its documentation, and run common development tasks.
|
|
25
25
|
|
|
26
26
|
## Trigger Conditions
|
|
27
27
|
|
|
28
|
-
Invoke this skill when
|
|
28
|
+
Invoke this skill when:
|
|
29
29
|
|
|
30
|
-
1. `AGENTS.md
|
|
31
|
-
2. `AGENTS.md
|
|
30
|
+
1. `AGENTS.md` or `CLAUDE.md` does not exist.
|
|
31
|
+
2. `AGENTS.md` or `CLAUDE.md` exists but may have drifted after code changes, documentation updates, or workflow changes.
|
|
32
|
+
3. After `align-project-documents` has updated the `docs/` structure and the document index needs to be refreshed.
|
|
32
33
|
|
|
33
|
-
|
|
34
|
+
## Required Output Format
|
|
34
35
|
|
|
35
|
-
|
|
36
|
+
`AGENTS.md`/`CLAUDE.md` must contain exactly three sections:
|
|
36
37
|
|
|
37
|
-
|
|
38
|
+
### 1. Common Development Commands
|
|
38
39
|
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
40
|
+
- Include only commands that are real, current, and useful in this repository.
|
|
41
|
+
- Prefer repository-owned entry points: package scripts, CLIs, `bin/` programs, `scripts/`, `Makefile`, `justfile`, or equivalent task runners.
|
|
42
|
+
- For each command, explain when to use it in one short phrase.
|
|
43
|
+
- Prioritize commands that help an agent inspect, validate, build, test, or operate the repository.
|
|
44
|
+
- Do not invent commands, aliases, flags, or task names not traceable to the repository.
|
|
44
45
|
|
|
45
|
-
|
|
46
|
+
### 2. Project Business Goals
|
|
46
47
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
4. Keep it concise, but make sure the purpose is understandable without reading the rest of the document.
|
|
48
|
+
- Describe the project's macro business purpose: what problem it solves, what outcome it aims to achieve, who it serves.
|
|
49
|
+
- Write at the product or business level, not at the implementation level.
|
|
50
|
+
- Keep it concise but self-contained — a reader should understand why the project exists without reading other documents.
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
### 3. Project Documentation Index
|
|
53
53
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
5. Do not invent commands, aliases, flags, or task names that are not traceable to the repository.
|
|
54
|
+
- List all standardized project documentation files under `docs/`.
|
|
55
|
+
- Organize by category: `docs/features/`, `docs/architecture/`, `docs/principles/`.
|
|
56
|
+
- For each document, provide the file path and a one-line description of what it covers.
|
|
57
|
+
- List any additional root-level documentation files (e.g., `README.md`, `CONTRIBUTING.md`, `SECURITY.md`).
|
|
59
58
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
1. One short sentence that summarizes what the repository currently enables.
|
|
63
|
-
2. An exhaustive unordered list of the repository's current existing functions/capabilities.
|
|
64
|
-
3. Each bullet must be a short capability statement, preferably in the style of `- Users can ...` or the repository-equivalent actor phrasing.
|
|
65
|
-
|
|
66
|
-
Example:
|
|
59
|
+
### Template Example
|
|
67
60
|
|
|
68
61
|
```markdown
|
|
62
|
+
## Common Development Commands
|
|
69
63
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
- `npm test` — run the repository's automated test suite.
|
|
64
|
+
- `npm test` — run the test suite.
|
|
65
|
+
- `npm run build` — compile the project for production.
|
|
73
66
|
- `apltk validate-skill-frontmatter` — validate every top-level `SKILL.md` frontmatter block.
|
|
74
|
-
- `apltk validate-openai-agent-config` — validate every `agents/openai.yaml` interface config.
|
|
75
|
-
- `apltk codex` — install the current toolkit into the local Codex skills directory.
|
|
76
67
|
|
|
77
|
-
##
|
|
68
|
+
## Project Business Goals
|
|
78
69
|
|
|
79
70
|
This project enables users to manage and run reusable automation workflows.
|
|
71
|
+
It solves the problem of scattered, inconsistent automation scripts by providing a unified catalog of versioned, validated skills.
|
|
72
|
+
|
|
73
|
+
## Project Documentation Index
|
|
74
|
+
|
|
75
|
+
### Features (`docs/features/`)
|
|
76
|
+
|
|
77
|
+
- `docs/features/skill-management.md` — skill creation, editing, and lifecycle management
|
|
78
|
+
- `docs/features/validation.md` — skill and configuration validation workflows
|
|
79
|
+
|
|
80
|
+
### Architecture (`docs/architecture/`)
|
|
81
|
+
|
|
82
|
+
- `docs/architecture/skill-system.md` — skill loading, resolution, and execution model
|
|
83
|
+
- `docs/architecture/validation-pipeline.md` — validation pipeline design
|
|
84
|
+
|
|
85
|
+
### Principles (`docs/principles/`)
|
|
86
|
+
|
|
87
|
+
- `docs/principles/naming-conventions.md` — file and identifier naming rules
|
|
88
|
+
- `docs/principles/dependency-management.md` — internal and external dependency rules
|
|
89
|
+
|
|
90
|
+
### Root Documents
|
|
80
91
|
|
|
81
|
-
-
|
|
82
|
-
- Users can update an existing workflow configuration.
|
|
83
|
-
- Users can validate workflow inputs before execution.
|
|
84
|
-
- Users can run the workflow and inspect the result.
|
|
92
|
+
- `README.md` — project overview and quick start
|
|
85
93
|
```
|
|
86
94
|
|
|
87
95
|
## Workflow
|
|
88
96
|
|
|
89
|
-
### 1) Build factual understanding
|
|
97
|
+
### 1) Build factual understanding
|
|
90
98
|
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
- repository command
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
- test directories and tooling/config files
|
|
99
|
-
- Infer architecture and conventions from real code, not assumptions.
|
|
100
|
-
- Build a concrete inventory of all currently implemented capabilities before drafting `Core business flow`.
|
|
101
|
-
- Build a separate inventory of stable, repository-specific commands before drafting `Common Commands`.
|
|
99
|
+
- Read the repository entry points, configuration, and command surfaces (`package.json`, `bin/`, `scripts/`, `Makefile`, etc.).
|
|
100
|
+
- If standardized project documentation exists under `docs/`, read `docs/features/`, `docs/architecture/`, and `docs/principles/` to understand the documented capabilities and to build the index.
|
|
101
|
+
- If `docs/` does not exist or is incomplete, read the source code directly to extract business goals and common commands.
|
|
102
|
+
- Build a concrete inventory of:
|
|
103
|
+
- Every stable, repository-specific command.
|
|
104
|
+
- The project's macro business purpose (from docs, README, or inferred from the codebase's capabilities).
|
|
105
|
+
- Every file under `docs/` that should appear in the index.
|
|
102
106
|
|
|
103
|
-
### 2)
|
|
107
|
+
### 2) Extract macro business goals
|
|
104
108
|
|
|
105
|
-
|
|
109
|
+
- Derive the project's business purpose from:
|
|
110
|
+
1. Existing documentation (`README.md`, `docs/features/`) if available.
|
|
111
|
+
2. The set of user-facing capabilities found in the codebase.
|
|
112
|
+
- Write at the product level: what problem does this solve? who uses it? what outcome does it produce?
|
|
113
|
+
- Do not restate implementation details or list features; the document index already points to feature docs.
|
|
106
114
|
|
|
107
|
-
|
|
108
|
-
- Document architecture, business flow, purpose, and coding conventions from observed facts.
|
|
109
|
-
- Write `Core project purpose` as the repository's macro intent, such as the problem it aims to solve or the outcome it exists to achieve, rather than as a feature list.
|
|
110
|
-
- Document the repository's common commands from observed command entry points and docs.
|
|
111
|
-
- Write `Core business flow` as one summary sentence followed by unordered bullets that cover every current capability found in the repository.
|
|
112
|
-
- Write `Common commands` as short bullets in the style of ``- `command` — when to use it.``.
|
|
113
|
-
- Keep language specific to this repository; avoid generic boilerplate.
|
|
115
|
+
### 3) Write or update AGENTS.md/CLAUDE.md
|
|
114
116
|
|
|
115
|
-
|
|
117
|
+
- If `AGENTS.md` exists, update it. If `CLAUDE.md` exists, update it. If both exist, update both with identical content for the three sections.
|
|
118
|
+
- If neither exists, check for the repository's convention and create the appropriate file.
|
|
119
|
+
- Write only the three sections: Common Development Commands, Project Business Goals, Project Documentation Index.
|
|
120
|
+
- Do not add architecture descriptions, code style guidance, business flows, or any content that belongs in `docs/`.
|
|
116
121
|
|
|
117
|
-
|
|
122
|
+
### 4) Maintain the project documentation index
|
|
118
123
|
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
- Preserve correct existing content and structure where possible.
|
|
124
|
+
- Enumerate every file under `docs/features/`, `docs/architecture/`, and `docs/principles/`.
|
|
125
|
+
- For each file, write a one-line description of what it covers.
|
|
126
|
+
- List root-level documentation files (`README.md`, `CONTRIBUTING.md`, `SECURITY.md`, `CHANGELOG.md`, etc.) that exist in the repository.
|
|
127
|
+
- Keep the index synchronized with the actual files on disk; remove entries for deleted files and add entries for new files.
|
|
124
128
|
|
|
125
|
-
###
|
|
129
|
+
### 5) Quality checks before finishing
|
|
126
130
|
|
|
127
|
-
-
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
- Verify
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
- Keep instructions concise, concrete, and operational for future agents.
|
|
131
|
+
- Verify every command in Common Development Commands is traceable to a repository entry point.
|
|
132
|
+
- Verify Project Business Goals describes the macro purpose, not a feature list.
|
|
133
|
+
- Verify every file listed in the Documentation Index exists on disk.
|
|
134
|
+
- Verify the index covers all files under `docs/features/`, `docs/architecture/`, and `docs/principles/`.
|
|
135
|
+
- If both `AGENTS.md` and `CLAUDE.md` exist, verify their content is consistent.
|
|
136
|
+
- Remove any sections beyond the three required ones.
|
|
134
137
|
|
|
135
138
|
## Writing Rules
|
|
136
139
|
|
|
137
|
-
-
|
|
138
|
-
-
|
|
139
|
-
- Do not
|
|
140
|
-
- In
|
|
141
|
-
- In
|
|
142
|
-
-
|
|
143
|
-
- Keep the document focused on how agents should understand and operate in this project.
|
|
140
|
+
- Keep the document concise and scannable.
|
|
141
|
+
- Use the repository's own terminology.
|
|
142
|
+
- Do not speculate about architecture or implementation details.
|
|
143
|
+
- In Project Business Goals, describe the macro purpose; for example, the user or business problem the project solves.
|
|
144
|
+
- In the Documentation Index, prefer descriptive one-line summaries over bare file paths.
|
|
145
|
+
- When both `AGENTS.md` and `CLAUDE.md` exist, keep their content identical for the three sections.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Maintain Project Constraints"
|
|
3
|
-
short_description: "
|
|
4
|
-
default_prompt: "Use $maintain-project-constraints to
|
|
3
|
+
short_description: "Create and maintain AGENTS.md/CLAUDE.md with business goals, common commands, and project doc index"
|
|
4
|
+
default_prompt: "Use $maintain-project-constraints to read the codebase or existing project docs, extract the project's macro business goals, inventory common development commands, enumerate all standardized docs under docs/features/, docs/architecture/, and docs/principles/, then write or update AGENTS.md/CLAUDE.md with exactly three sections: Common Development Commands, Project Business Goals, and Project Documentation Index. If both AGENTS.md and CLAUDE.md exist, keep their content consistent."
|
|
Binary file
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/align-project-documents/references/templates/category-based-project-docs-template.md
DELETED
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
# Category-Based Project Documentation Template
|
|
2
|
-
|
|
3
|
-
Use this template as a selection guide, not a mandatory outline. Start by classifying the repository's real content and the readers' likely questions, then choose only the document categories and section blocks that are actually supported by evidence.
|
|
4
|
-
|
|
5
|
-
Base the classification on common open source documentation practice:
|
|
6
|
-
|
|
7
|
-
- Use the Diataxis content families when deciding what kind of content you are writing: tutorial, how-to, reference, and explanation.
|
|
8
|
-
- Use common open source repository documents when deciding where the content should live: `README`, `CONTRIBUTING`, `SECURITY`, `CODE_OF_CONDUCT`, troubleshooting guides, glossary, and release notes when applicable.
|
|
9
|
-
- Use The Good Docs Project templates as a practical guide for selecting content types that teams repeatedly need in real projects.
|
|
10
|
-
|
|
11
|
-
## 1. Start With Reader And Content Classification
|
|
12
|
-
|
|
13
|
-
Before writing, identify:
|
|
14
|
-
|
|
15
|
-
| Classification | Questions to answer | Example answers |
|
|
16
|
-
| --- | --- | --- |
|
|
17
|
-
| Primary readers | Who needs this document first? | New developer, operator, support teammate, PM, founder |
|
|
18
|
-
| Reader background | What might they not know yet? | No repo context, no local setup experience, no domain knowledge |
|
|
19
|
-
| Main job to be done | What is the reader trying to accomplish? | Run locally, change a feature, deploy, debug an incident |
|
|
20
|
-
| Evidence sources | Which files prove the behavior? | `README.md`, `package.json`, `src/server.ts`, `.github/workflows/deploy.yml` |
|
|
21
|
-
| Documentation risk | What would go wrong if this is undocumented? | Broken onboarding, misconfigured secrets, incorrect production operation |
|
|
22
|
-
|
|
23
|
-
Write the document around the real questions above. Do not force a category or section when the repository does not support it.
|
|
24
|
-
|
|
25
|
-
## 2. Choose The Right Document Categories
|
|
26
|
-
|
|
27
|
-
Select one or more categories below. Keep the titles content-led and specific. Prefer titles such as `本地啟動後端服務`, `設定 Stripe 測試金鑰`, or `訂單同步失敗時如何排查`, instead of generic headings that hide the real task.
|
|
28
|
-
|
|
29
|
-
| Open source documentation type | Diataxis family | Use when the repository contains... | Main reader need | Suggested output path |
|
|
30
|
-
| --- | --- | --- | --- |
|
|
31
|
-
| README / docs index | Mixed entrypoint | Clear project purpose, user value, repo scope, key links | "What is this project and where do I start?" | `README.md`, `docs/README.md` |
|
|
32
|
-
| Tutorial / getting started | Tutorial | A first-run path that teaches by doing | "Help me complete my first successful run." | `docs/getting-started.md`, `docs/tutorials/*.md` |
|
|
33
|
-
| How-to / runbook / operations guide | How-to | Repeated workflows, CLI commands, dashboards, jobs, support actions | "How do I perform this real task?" | `docs/how-to/*.md`, `docs/runbooks/*.md`, `docs/operations.md` |
|
|
34
|
-
| Reference / configuration catalog | Reference | Env vars, config files, commands, endpoints, state tables, limits | "What options, inputs, or values exist?" | `docs/configuration.md`, `docs/reference/*.md` |
|
|
35
|
-
| Explanation / architecture / concepts | Explanation | Module boundaries, data flow, ownership, state transitions, tradeoffs | "How is this built and why is it shaped this way?" | `docs/architecture.md`, `docs/concepts/*.md` |
|
|
36
|
-
| Troubleshooting | How-to + reference | Known symptoms, causes, checks, recovery actions | "What should I check when it breaks?" | `docs/troubleshooting.md`, `docs/runbooks/*.md` |
|
|
37
|
-
| CONTRIBUTING | How-to + explanation | Contribution flow, local validation, review expectations | "How do I contribute safely?" | `CONTRIBUTING.md`, `docs/developer-guide.md` |
|
|
38
|
-
| SECURITY | How-to + reference | Vulnerability reporting process, supported versions, security boundaries | "How should I report a security issue?" | `SECURITY.md` |
|
|
39
|
-
| CODE_OF_CONDUCT | Community governance | Community expectations and reporting path | "How does this project expect people to behave?" | `CODE_OF_CONDUCT.md` |
|
|
40
|
-
| Glossary / terminology | Reference | Business rules, lifecycle states, project vocabulary, permissions | "What do these terms mean?" | `docs/glossary.md`, `docs/terminology.md` |
|
|
41
|
-
| FAQ / decisions / release notes | Explanation + reference | Repeated questions, key tradeoffs, notable changes | "Why was this choice made?" / "What changed?" | `docs/faq.md`, `docs/decisions/*.md`, `CHANGELOG.md` |
|
|
42
|
-
|
|
43
|
-
### Selection Rules
|
|
44
|
-
|
|
45
|
-
- Start by asking which Diataxis family the content belongs to.
|
|
46
|
-
- Then choose the most conventional open source document type that readers would expect to find.
|
|
47
|
-
- Do not merge tutorial, how-to, reference, and explanation into one page unless the repository is genuinely small enough that separation would hurt readability.
|
|
48
|
-
- Keep community-governance documents such as `CONTRIBUTING`, `SECURITY`, and `CODE_OF_CONDUCT` separate from product usage docs.
|
|
49
|
-
- When a document mixes content types, decide which type is primary and move the rest behind links.
|
|
50
|
-
|
|
51
|
-
## 3. Section Blocks You Can Reuse Inside Any Document
|
|
52
|
-
|
|
53
|
-
Use only the blocks that help the target reader. Rename each heading to match the specific content.
|
|
54
|
-
|
|
55
|
-
### A. Reader Context Block
|
|
56
|
-
|
|
57
|
-
Use when the reader may not understand the project or task yet.
|
|
58
|
-
|
|
59
|
-
- Who should read this:
|
|
60
|
-
- What they are probably trying to do:
|
|
61
|
-
- What they need to know first:
|
|
62
|
-
- What success looks like after reading:
|
|
63
|
-
|
|
64
|
-
### B. Before You Start Block
|
|
65
|
-
|
|
66
|
-
Use for setup, operations, deployments, or debugging.
|
|
67
|
-
|
|
68
|
-
- Required tools or accounts:
|
|
69
|
-
- Required permissions or credentials:
|
|
70
|
-
- Files, services, or environments involved:
|
|
71
|
-
- Safe test or sandbox alternatives:
|
|
72
|
-
|
|
73
|
-
### C. Exact Steps Block
|
|
74
|
-
|
|
75
|
-
Use for any task-oriented content.
|
|
76
|
-
|
|
77
|
-
1. State the action in plain language.
|
|
78
|
-
2. Give the exact command, UI path, or file path.
|
|
79
|
-
3. Explain what result should appear.
|
|
80
|
-
4. Explain what to do if the result does not appear.
|
|
81
|
-
|
|
82
|
-
### D. Expected Signals Block
|
|
83
|
-
|
|
84
|
-
Use when readers need to confirm they are on the right path.
|
|
85
|
-
|
|
86
|
-
- Success logs, UI states, API responses, artifacts, or screenshots:
|
|
87
|
-
- Expected side effects:
|
|
88
|
-
- How long the step usually takes:
|
|
89
|
-
|
|
90
|
-
### E. Failure And Recovery Block
|
|
91
|
-
|
|
92
|
-
Use when the workflow can fail or confuse newcomers.
|
|
93
|
-
|
|
94
|
-
- Common mistake:
|
|
95
|
-
- Symptom:
|
|
96
|
-
- Likely cause:
|
|
97
|
-
- How to verify:
|
|
98
|
-
- How to fix:
|
|
99
|
-
|
|
100
|
-
### F. Code Navigation Block
|
|
101
|
-
|
|
102
|
-
Use for architecture or developer-facing docs.
|
|
103
|
-
|
|
104
|
-
- Entry point:
|
|
105
|
-
- Main modules and responsibilities:
|
|
106
|
-
- Important data models:
|
|
107
|
-
- External integration touchpoints:
|
|
108
|
-
- Highest-risk files to review before editing:
|
|
109
|
-
|
|
110
|
-
### G. Decision And Limitation Block
|
|
111
|
-
|
|
112
|
-
Use when the code or operations include tradeoffs.
|
|
113
|
-
|
|
114
|
-
- Current limitation:
|
|
115
|
-
- Why it exists:
|
|
116
|
-
- When it matters:
|
|
117
|
-
- Safe workaround:
|
|
118
|
-
- Evidence:
|
|
119
|
-
|
|
120
|
-
## 4. Newcomer-Friendly Writing Rules
|
|
121
|
-
|
|
122
|
-
Every non-trivial document should help a reader who does not yet know the project. Prefer explaining:
|
|
123
|
-
|
|
124
|
-
- what this part of the system is for
|
|
125
|
-
- why the reader would need it
|
|
126
|
-
- what they must prepare beforehand
|
|
127
|
-
- what exact action they should take
|
|
128
|
-
- what result they should expect
|
|
129
|
-
- what usually goes wrong
|
|
130
|
-
- where in the repository the truth lives
|
|
131
|
-
|
|
132
|
-
Avoid:
|
|
133
|
-
|
|
134
|
-
- headings that only repeat template words without conveying meaning
|
|
135
|
-
- assuming the reader already knows internal jargon
|
|
136
|
-
- mentioning files, services, or commands without saying why they matter
|
|
137
|
-
- mixing future plans with current behavior
|
|
138
|
-
|
|
139
|
-
## 5. Evidence Checklist
|
|
140
|
-
|
|
141
|
-
Before finishing, confirm:
|
|
142
|
-
|
|
143
|
-
- every important instruction maps to code, config, scripts, tests, or current deployment files
|
|
144
|
-
- every command is current and runnable, or explicitly marked as needing manual confirmation
|
|
145
|
-
- each document category exists because the repository actually needs it
|
|
146
|
-
- each heading is descriptive of the real content, not just copied from a template
|
|
147
|
-
- unknowns are labeled clearly instead of guessed
|
|
148
|
-
|
|
149
|
-
## 6. Example Of Category Selection
|
|
150
|
-
|
|
151
|
-
Example classification:
|
|
152
|
-
|
|
153
|
-
- Readers: new developer and part-time operator
|
|
154
|
-
- Main needs: local startup, environment configuration, order sync debugging
|
|
155
|
-
- Repository evidence: API server, worker process, queue config, deploy workflow, sync failure logs
|
|
156
|
-
|
|
157
|
-
Reasonable outputs:
|
|
158
|
-
|
|
159
|
-
- `README.md`: project overview and links
|
|
160
|
-
- `docs/getting-started.md`: tutorial-style first successful run
|
|
161
|
-
- `docs/configuration.md`: reference-style env vars and third-party credentials
|
|
162
|
-
- `docs/architecture.md`: explanation of API, worker, queue, and database boundaries
|
|
163
|
-
- `docs/runbooks/order-sync-failures.md`: how-to troubleshooting for order sync issues
|
|
164
|
-
- `CONTRIBUTING.md`: contribution flow, local checks, and review expectations if external contributors are expected
|
|
165
|
-
|
|
166
|
-
Not needed unless evidence supports them:
|
|
167
|
-
|
|
168
|
-
- `docs/glossary.md`
|
|
169
|
-
- `docs/faq.md`
|
|
170
|
-
- separate feature catalog for every route/page
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# Configuration
|
|
2
|
-
|
|
3
|
-
## 1. Environment Variables And Config Files
|
|
4
|
-
|
|
5
|
-
| Key / File | Required | Purpose | Example / Default | Evidence |
|
|
6
|
-
| --- | --- | --- | --- | --- |
|
|
7
|
-
| `[ENV_KEY]` | `[Yes/No]` | [What it controls] | [Example or default] | [File path] |
|
|
8
|
-
| `[config/file]` | `[Yes/No]` | [Why it matters] | [Example or default] | [File path] |
|
|
9
|
-
|
|
10
|
-
## 2. External Services And Credential Setup
|
|
11
|
-
|
|
12
|
-
### [Service Name]
|
|
13
|
-
|
|
14
|
-
- Purpose: [Why this service exists in the project]
|
|
15
|
-
- Required keys/config: `[ENV_KEY]`, `[CONFIG_KEY]`
|
|
16
|
-
- Official setup entry: [Link or exact console path if known]
|
|
17
|
-
- Acquisition steps:
|
|
18
|
-
1. [Create or open the relevant account/project]
|
|
19
|
-
2. [Generate/find the credential]
|
|
20
|
-
3. [Store it in the local/deployment config]
|
|
21
|
-
4. [Verify connectivity]
|
|
22
|
-
- Development notes: [sandbox/test mode, rate limit, fake data, or `Unknown`]
|
|
23
|
-
- Evidence: [file path or spec path]
|
|
24
|
-
|
|
25
|
-
## 3. Safety Notes
|
|
26
|
-
|
|
27
|
-
- Secret handling: [where secrets should live]
|
|
28
|
-
- Local overrides: [env file / config layering / secret manager]
|
|
29
|
-
- Common misconfiguration symptoms: [brief list]
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# Developer Guide
|
|
2
|
-
|
|
3
|
-
## 1. Domain Concepts To Know
|
|
4
|
-
|
|
5
|
-
- [Business rule, glossary term, permission model, lifecycle concept]
|
|
6
|
-
- [Business rule, glossary term, permission model, lifecycle concept]
|
|
7
|
-
|
|
8
|
-
## 2. Change Hotspots
|
|
9
|
-
|
|
10
|
-
- Critical modules: [paths or module names]
|
|
11
|
-
- External dependency touchpoints: [APIs/services/jobs]
|
|
12
|
-
- Data integrity or migration risks: [if any]
|
|
13
|
-
- Concurrency / idempotency concerns: [if any]
|
|
14
|
-
|
|
15
|
-
## 3. Testing Expectations
|
|
16
|
-
|
|
17
|
-
- Required test layers: [unit / integration / E2E / property-based]
|
|
18
|
-
- Mock/fake expectations: [where external dependencies should be isolated]
|
|
19
|
-
- High-value regression areas: [bug-prone workflows]
|
|
20
|
-
|
|
21
|
-
## 4. Debugging Entry Points
|
|
22
|
-
|
|
23
|
-
- Logs: [paths / commands / tools]
|
|
24
|
-
- Local reproduction commands: [commands]
|
|
25
|
-
- Dashboards or observability tools: [if any]
|
|
26
|
-
- Common failure signals: [errors / symptoms]
|
|
27
|
-
|
|
28
|
-
## 5. Documentation Maintenance Notes
|
|
29
|
-
|
|
30
|
-
- Specs reviewed: [list of spec directories/files]
|
|
31
|
-
- Existing docs updated: [paths]
|
|
32
|
-
- Major conflicts resolved: [spec vs code decisions]
|
|
33
|
-
- Remaining unknowns: [list or `None`]
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# Getting Started
|
|
2
|
-
|
|
3
|
-
## 1. Purpose
|
|
4
|
-
|
|
5
|
-
- Project purpose: [What the project exists to do]
|
|
6
|
-
- Primary users: [Who uses it]
|
|
7
|
-
- Supported environments: [local / staging / production / other]
|
|
8
|
-
|
|
9
|
-
## 2. Prerequisites
|
|
10
|
-
|
|
11
|
-
- Runtime/tooling: [Node/Python/Docker/etc.]
|
|
12
|
-
- Accounts/services needed: [if any]
|
|
13
|
-
- Local dependencies: [database, queue, browser, etc.]
|
|
14
|
-
|
|
15
|
-
## 3. Installation
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
[Clone / install / bootstrap commands]
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## 4. Local Run
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
[Run or dev server commands]
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## 5. Deployment
|
|
28
|
-
|
|
29
|
-
- Deployment targets: [where it deploys]
|
|
30
|
-
- Deployment command or pipeline: [command / CI job / script]
|
|
31
|
-
- Required pre-deploy checks: [tests, migrations, approvals]
|
|
32
|
-
- Rollback notes: [how rollback works or `Unknown`]
|
|
33
|
-
|
|
34
|
-
## 6. Verification
|
|
35
|
-
|
|
36
|
-
- Smoke checks: [command / URL / workflow]
|
|
37
|
-
- Expected signals: [log, page, API response, artifact]
|
|
38
|
-
- Evidence: [file path or command path]
|