Technical Reviewer Assignment for Documentation Translation
Technical Reviewer Assignment for Documentation Translation
Section titled “Technical Reviewer Assignment for Documentation Translation”This document outlines the technical reviewer assignments for each documentation section in the English translation project.
Reviewer Roles
Section titled “Reviewer Roles”Technical Reviewer
Section titled “Technical Reviewer”Responsible for:
- Verifying code examples are technically accurate and executable
- Checking configuration values and commands are correct
- Ensuring technical concepts are properly explained
- Validating technical terminology accuracy
Language Reviewer
Section titled “Language Reviewer”Responsible for:
- Ensuring English is natural and readable
- Checking grammar and spelling
- Verifying terminology consistency with TERMS.md
- Confirming tone matches documentation style
Section Assignments
Section titled “Section Assignments”Phase 1: Core User Journey Documentation
Section titled “Phase 1: Core User Journey Documentation”| Section | Files | Technical Reviewer | Language Reviewer |
|---|---|---|---|
| Product Overview | product-overview.mdx | @newbe36524 | TBD |
| Quick Start Guides | quick-start/*.mdx | @newbe36524 | TBD |
| Installation Guides | installation/*.mdx | @newbe36524 | TBD |
Phase 2: Feature Documentation
Section titled “Phase 2: Feature Documentation”| Section | Files | Technical Reviewer | Language Reviewer |
|---|---|---|---|
| Monospec Guide | guides/monospecs.mdx | @newbe36524 | TBD |
| AI Compose Commit | guides/ai-compose-commit.mdx | @newbe36524 | TBD |
| Contributor Guide | contributor-guide.mdx | @newbe36524 | TBD |
Phase 3: Extended Documentation
Section titled “Phase 3: Extended Documentation”| Section | Files | Technical Reviewer | Language Reviewer |
|---|---|---|---|
| Related Software Installation | related-software-installation/**/*.mdx | @newbe36524 | TBD |
| Blog Posts | blog/**/*.mdx | @newbe36524 | TBD |
Review Process
Section titled “Review Process”1. Technical Review Checklist
Section titled “1. Technical Review Checklist”- Code examples are syntactically correct
- Code examples are executable
- Configuration files have correct keys and values
- Shell commands are accurate
- Technical concepts are properly explained
- No technical information is lost in translation
2. Language Review Checklist
Section titled “2. Language Review Checklist”- English is natural and readable
- Grammar and spelling are correct
- Terminology matches TERMS.md
- Capitalization follows style guide
- No literal translations that sound awkward
- Tone matches documentation style
3. Consistency Review Checklist
Section titled “3. Consistency Review Checklist”- Internal links use
/en/prefix - External links are preserved
- Formatting matches other English pages
- Structure matches original Chinese page
Review Workflow
Section titled “Review Workflow”- PR Created: Translator submits translation PR
- Technical Review: Assigned technical reviewer validates technical accuracy
- Language Review: Assigned language reviewer validates language quality
- Feedback: Reviewers provide feedback if needed
- Revision: Translator makes required changes
- Approval: Both reviewers approve
- Merge: PR is merged to main branch
Escalation Path
Section titled “Escalation Path”If reviewers disagree or have questions:
- Discuss in PR comments
- If unresolved, escalate to @newbe36524 for final decision
- Update TERMS.md if new terminology decisions are made
Onboarding New Reviewers
Section titled “Onboarding New Reviewers”To add a new reviewer:
- Assign them to relevant sections in this document
- Share TERMS.md and style guidelines
- Provide example translations for reference
- Walk through review checklist
Last Updated: 2026-02-26
Maintainer: Hagicode Documentation Team
Version: 1.0