Documentation QA Activities 2023
- Uwe Wahser
- Marco Kalin
- Dragos Dobre
- 1 Public Facing
- 1.1 General
- 1.2 Users
- 1.3 Implementers
- 1.4 Developers
- 1.4.1 Development guidelines
- 1.4.2 Github
- 1.4.3 Architecture
- 1.4.4 Release
- 1.4.5 Documentation Methodology
- 2 Internal Documentation
- 3 Guiding Principles
- 4 Taskforces
Collection of tasks to improve openIMIS Documentation
Public Facing
General
Wiki
Restructure the documentation landing page: Documentation (developer, implementer, user)
Provide near time status updates for Sandbox Landscape : Status monitor page for demo instance has been added, outstanding for others
Reorganize Release Notes - Releases
SEO for the Wiki and the Website - Communication
Rework wiki “Spaces”
List of regular wiki maintenance tasks (e.g. update events, opportunities, projects, clean archive …) → Wiki Maintenance
Restructure Wiki (Wiki Target Structure [Draft] ) to optimize accessibility to knowledge for different target groups
Ensure usability for low resolution devices / old displays (e.g. including links to child pages on every page)
Ensure usability for old/slow devices e.g. by reducing the number of unnecessary page loads
Ensure, that every page is converted to the new editor
Provide translations (e.g. in French) of the most important content → communications
Harmonize multi-language selection/navigation → communication
Use custom domain name for the Wiki (wiki.openimis.org)
Is currently not supported by the cloud-hosted Confluence Wiki → https://jira.atlassian.com/browse/CLOUD-6999
Report Copy & Paste (Links) Bug
Web-Page
Introduce issue queue for web-maintenance → https://openimis.atlassian.net/jira/software/c/projects/OOW/boards/23
Maintain https://openimis.atlassian.net/wiki/spaces/SB/pages/1025015809
cross link language version in wiki-version of the web-page
Users
Improve user documentation http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/
Update user documentation to current cooperate design (use new logo)
Links towards the Wiki need to be checked (e.g. “openIMIS Install documentation”)
Ensure coherency of the linkage between the user documentation and other platforms (like the Wiki or the webpage)
Update FAQ List
Remove usage of featured FAQ lists outside of the website sandbox
Move to Sandbox
Implementers
Validate and Integrate Installation Guide into Documentation
Update Installation Guide to allow people that are interested to quickly setup the current version in the supported environment (Linux & PostgreSQL)
Variations as “Implementers Experience reports” as link out from the standard installation instruction e.g. “see other
Clean up naming: “modular” is default case and doesn’t need to be especially designated as such for the purpose of Documentation , “legacy” is special case, its content need to be updated/removed/archived to reflect the new reality - E.g. in Installation Guide - This also needs to be reflected in documentation within the (GitHub) repositories
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/589463708 into Documentation
Integrate further mature/non-development content into Documentation
Describe Configuration/Customization (per module) in Documentation ↔︎ Dev Committee #288
Create “How to migrate from Legacy to Modular” (see https://openimis.atlassian.net/wiki/spaces/OP/pages/3284271107)
Create “How to update from version / release x to version / release y” tutorial
Validatehttps://openimis.atlassian.net/wiki/spaces/OP/pages/1343881261 and Document Testing Scenarios ↔︎ Dev Committee #223
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/1450672243 into Documentation
Validate and Integrate Sandbox Landscape into https://openimis.atlassian.net/wiki/spaces/OP/pages/215351328
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/759070721 into Documentation
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/689602562 into https://openimis.atlassian.net/wiki/spaces/OP/pages/215351328
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/40665170 into https://openimis.atlassian.net/wiki/spaces/OP/pages/215351328
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/2679799817 into Documentation
Developers
Development guidelines
Update https://openimis.atlassian.net/wiki/spaces/OP/pages/1277493249 for https://openimis.atlassian.net/wiki/spaces/OP/pages/3211395073
Update Installation Guide for https://openimis.atlassian.net/wiki/spaces/OP/pages/3211395073
Create “Technical Requirements” page and fill with content e.g. https://openimis.atlassian.net/wiki/spaces/OP/pages/898924553
Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3077472261 into Documentation
Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/290455555
Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/1425473537
Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/619380737
Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3193798657 into Documentation
Integrate “
Automated CI testing" of https://openimis.atlassian.net/wiki/spaces/OP/pages/3077472261 into Documentation
Validate and integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3288694789 into