Samuel: Samuel moved page AOWIS:Naming Convention Specification to AOWIS:Naming Convention Specification/v1.0

2026-04-01T03:36:35Z

Samuel moved page AOWIS:Naming Convention Specification to AOWIS:Naming Convention Specification/v1.0

← Older revision		Revision as of 03:36, 1 April 2026
(No difference)

Samuel: Created page with "{{DISPLAYTITLE: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 b..."

2026-04-01T03:19:33Z

Created page with "{{DISPLAYTITLE: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 b..."

New page

{{DISPLAYTITLE: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:
<pre>
ResearchForm:Title/vX.X
</pre>

Example:
<pre>
ResearchForm:Communication Methods for Offline-First Controllers/v1.0
</pre>

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:
<pre>
ResearchForm:Title
</pre>

Purpose:
* Redirects to latest version

Example:
<pre>
#REDIRECT [[ResearchForm:Communication Methods for Offline-First Controllers/v1.1]]
</pre>

---

=== 3.3 Standard Pages ===

Format:
<pre>
Standard:Title
</pre>

Example:
<pre>
Standard:Field Controller Responsibilities
</pre>

---

=== 3.4 Concept Pages ===

Format:
<pre>
Concept:Title
</pre>

Example:
<pre>
Concept:Offline-First Operation
</pre>

---

=== 3.5 Module Pages ===

Format:
<pre>
Module:Title
</pre>

Example:
<pre>
Module:Pump Control
</pre>

---

== 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:

<pre>
ResearchForm:Communication Methods for Offline-First Controllers/v1.0
ResearchForm:Communication Methods for Offline-First Controllers/v1.1
</pre>

---

== 5. Linking Between Versions ==

Each new version SHOULD include:

<pre>
== Previous Versions ==
* [[ResearchForm:Title/v1.0]] – initial version
</pre>

Older versions MAY include:

<pre>
== Newer Versions ==
* [[ResearchForm:Title/v1.1]]
</pre>

---

== 6. Category Usage ==

Pages MUST include appropriate categories.

Examples:

<pre>
[[Category:AOWIS Research]]
[[Category:Communication]]
[[Category:Offline-First Systems]]
</pre>

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 ===

<pre>
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
</pre>

=== Incorrect ===

<pre>
ResearchForm:communication_methods_v1
ResearchForm:Communication Methods v1.1
ResearchForm:Comms Methods/v2
</pre>

----

== 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)''

AOWIS:Naming Convention Specification/v1.0 - Revision history

Samuel: Samuel moved page AOWIS:Naming Convention Specification to AOWIS:Naming Convention Specification/v1.0