Skip to content

Commit 5789d86

Browse files
docs: clarify bilingual documentation policy in AGENTS.md
Updated language requirements section to explicitly document: - Feature documentation: Required in both English and Japanese - Detailed technical documentation: English required, Japanese optional - Project-level documentation: Required in both languages Added rationale explaining that detailed docs are primarily for developers who typically read English technical documentation, and the significant volume makes translation effort substantial with limited additional value. Addresses Minor Observation #1 from PR review. Co-authored-by: FT-FumihikoUnno <[email protected]>
1 parent 8a2dd9f commit 5789d86

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

AGENTS.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,21 @@ Each ROS2 package in `src/` typically contains:
113113
## Documentation Standards
114114

115115
### Language Requirements
116-
All documentation must be provided in **both English and Japanese**:
117-
- **English**: Primary documentation (e.g., `AGENTS.md`, `feature.md`)
118-
- **Japanese**: Translation with `-ja` suffix (e.g., `AGENTS-ja.md`, `feature-ja.md`)
116+
Documentation language requirements vary by type:
117+
118+
**Feature Documentation** (`doc/feature/`):
119+
- **Required** in both English and Japanese
120+
- **English**: Primary documentation (e.g., `feature.md`)
121+
- **Japanese**: Translation with `-ja` suffix (e.g., `feature-ja.md`)
122+
123+
**Detailed Technical Documentation** (`doc/detail/`):
124+
- **English**: Required for all detailed implementation documentation
125+
- **Japanese**: Optional (translations welcomed but not mandatory)
126+
- Rationale: Detailed technical documentation is primarily for developers who typically read English technical documentation. The significant volume of detailed docs makes translation effort substantial while providing limited additional value.
127+
128+
**Project-level Documentation** (e.g., `AGENTS.md`, `README.md`):
129+
- **Required** in both English and Japanese
130+
- Follow the same `-ja` suffix convention
119131

120132
### File Naming Convention
121133
```

0 commit comments

Comments
 (0)