Documentation Writing Guide
Under Preparation This guide is currently being written. Please wait for completion.
Overview
This guide provides standards and best practices for writing documentation for the River Review project.
Planned Content
We plan to include the following:
Style and Formatting
- Markdown rules.
- Heading and section structure.
- Code block styling.
- Link and reference formats.
Tone and Expression
- Appropriate tone for technical documentation.
- Guidelines for terminology.
- Usage of Japanese and English.
- Adjusting expression for the audience.
Document Structure
- Templates for various document types.
- Recommended section configuration.
- Information hierarchy design.
- Navigation considerations.
Review and Quality Control
- Document review process.
- Checklists.
- Continuous improvement approach.
Interim Recommendations
Until the complete guide is ready, please follow these basic recommendations:
- Clarity: Aim for concise and clear sentences.
- Consistency: Match the style of existing documents.
- Accuracy: Verify technical content thoroughly.
- Accessibility: Make content easy to understand for all readers.
- Language Policy: Japanese version (
.md) is primary. If adding an English version, create.en.mdwith the same name. Priority is given to the Japanese version if content diverges.
Contribution
Contributions to improve this guide are also welcome. If you have suggestions or feedback, please create an Issue or submit a Pull Request.
Last Updated: October 26, 2025.