AOWIS:Contributor Guide External/v1.0

Instructions for external contributors submitting content, research, or updates to AOWIS pages.

---

1. Purpose

This guide defines how external contributors can provide content to AOWIS. External contributors do not have direct write access to the wiki. All submissions must be reviewed and integrated by AOWIS staff.

---

2. Who Should Use This Guide

This guide is intended for any external contributor interested in providing content, ideas, or research to AOWIS. Examples include, but are not limited to:

• Engineers or software developers exploring AOWIS concepts
• Researchers studying water and agricultural infrastructure
• Field practitioners or NGOs sharing observations or findings
• Anyone interested in contributing to AOWIS standards or explanatory content

---

3. Contribution Workflow

1. Identify the target page on the AOWIS wiki where your contribution belongs. 2. Determine if you are:

• Adding a new page
• Updating an existing section

3. Prepare your contribution in a text file or other structured format.

Include in your submission:

• Target page URL (e.g., Modules:Pump_Controller)
• Section of the page for linking (optional)
• Proposed version (e.g., v1.0 for new pages, v1.1 for updates)
• Contribution content

---

4. Submission Template

Use the following format for your submission:

Target page URL: 
Target section (optional): 
Proposed version (vX.X): 
Title of contribution: 
Content:

<your content goes here>

Notes

• Content MUST follow the AOWIS Writing Style Guide
• Use normative statements (MUST, SHOULD, MAY) only if clearly testable
• Include units for all measurements
• Define all terms before use

---

5. Content Guidelines

• Normative requirements:

 - Use RFC 2119 keywords for requirements  
 - One requirement per statement  

• Explanatory content:

 - Provide context and rationale  
 - Include examples if helpful  

• References:

 - Cite sources, standards, or datasets when relevant  

• Human actions:

 - Explicitly describe user inputs or interactions  
 - Avoid vague instructions such as "if needed"

---

6. Versioning

• Include a proposed version number for each submission (v1.0, v1.1, etc.)
• Indicate whether it is a new page or update to an existing page
• Internal staff will create the actual wiki page with /vX.X naming and handle redirects

---

7. Review Process

• AOWIS staff will review submissions for:
  • Accuracy and technical correctness
  • Conformance with writing style
  • Proper namespace assignment and versioning
• Staff may request revisions before integration into the wiki

---

8. Submission Channels

• Email, shared repository, or ticketing system as directed by AOWIS
• Include all metadata (target page, section, version) in the submission

---

9. Linking from Existing Pages

If your contribution should be linked from an existing page:

• Specify the exact section or location
• Indicate whether it should appear as a reference, note, or inline content
• Staff will insert the link during integration

---

10. Summary

External contributors:

• Do not edit the wiki directly
• Submit contributions in structured text format
• Provide clear metadata (target page, section, version)
• Follow AOWIS writing standards
• Allow staff to integrate and version content

---

End of AOWIS External Contributor Guide (v1.0)