AOWIS Naming Convention Specification (v1.0)
Defines naming rules for AOWIS wiki pages to ensure consistency, traceability, and scalability.
1. Purpose
This specification defines how pages in the AOWIS wiki MUST be named.
Goals:
- Ensure consistency across all pages
- Enable predictable navigation and linking
- Support versioning and auditability
- Prevent ambiguity and duplication
2. General Naming Rules
- Names MUST be descriptive and unambiguous
- Names MUST use Title Case
- Names MUST NOT include unnecessary words (e.g., "Document", "Page")
- Names MUST use spaces, not underscores
- Names MUST NOT include version numbers in the base page name
- Names SHOULD avoid abbreviations unless standardized (e.g., MQTT)
Example:
Good:
- Communication Methods for Offline-First Controllers
Bad:
- comms_methods_v2
- ControllerStuff
- Research Document 1
3. Namespace Prefixes
All pages MUST use a functional prefix to indicate type.
3.1 Research Pages
Format:
ResearchForm:Title/vX.X
Example:
ResearchForm:Communication Methods for Offline-First Controllers/v1.0
Rules:
- Each version MUST be a separate page
- Version MUST appear after a slash (/vX.X)
- Base title MUST remain identical across versions
---
3.2 Research Landing Page (Optional but Recommended)
Format:
ResearchForm:Title
Purpose:
- Redirects to latest version
Example:
#REDIRECT [[ResearchForm:Communication Methods for Offline-First Controllers/v1.1]]
---
3.3 Standard Pages
Format:
Standard:Title
Example:
Standard:Field Controller Responsibilities
---
3.4 Concept Pages
Format:
Concept:Title
Example:
Concept:Offline-First Operation
---
3.5 Module Pages
Format:
Module:Title
Example:
Module:Pump Control
---
4. Versioning Rules
- Versions MUST use format: vX.X
- Version MUST appear only in the page suffix (/vX.X)
- Previous versions MUST NOT be modified after publication
- New versions MUST be created as new pages
Example:
ResearchForm:Communication Methods for Offline-First Controllers/v1.0 ResearchForm:Communication Methods for Offline-First Controllers/v1.1
---
5. Linking Between Versions
Each new version SHOULD include:
== Previous Versions == * [[ResearchForm:Title/v1.0]] – initial version
Older versions MAY include:
== Newer Versions == * [[ResearchForm:Title/v1.1]]
---
6. Category Usage
Pages MUST include appropriate categories.
Examples:
[[Category:AOWIS Research]] [[Category:Communication]] [[Category:Offline-First Systems]]
Rules:
- Categories MUST be consistent across versions
- Categories SHOULD reflect topic, not page type only
7. Prohibited Patterns
The following MUST NOT be used:
- Mixing version formats (e.g., v1, version1, 1.0-final)
- Including version in base title
- Changing title wording between versions
- Creating duplicate pages with similar names
Bad examples:
- ResearchForm:Comms Methods/v1.0
- ResearchForm:Communication Methods v1.1
- ResearchForm:Communication Methods Updated
8. Examples
Correct
ResearchForm:Communication Methods for Offline-First Controllers/v1.0 ResearchForm:Communication Methods for Offline-First Controllers/v1.1 Concept:Offline-First Operation Module:Pump Control
Incorrect
ResearchForm:communication_methods_v1 ResearchForm:Communication Methods v1.1 ResearchForm:Comms Methods/v2
9. Summary
- Use clear, descriptive titles
- Use namespace prefixes (ResearchForm:, Concept:, Module:, Standard:)
- Use version suffix (/vX.X) for research pages
- Create a new page for each version
- Keep titles identical across versions
End of AOWIS Naming Convention Specification (v1.0)