Documentation QA Activities 2022

Collection of tasks to improve openIMIS Documentation

Public Facing

General

Users

Implementers

Domain Knowledge

Priorization Toumai Community

  1. Modular Approach and Modules

  2. Interoperability (FHIR/DHIS2…)

  3. AI Modules

  4. Mobile Versions (Examples) / Payment Module (Examples)

Developers

Development guidelines

  1. Update https://openimis.atlassian.net/wiki/spaces/OP/pages/1277493249 for https://openimis.atlassian.net/wiki/spaces/OP/pages/3211395073

  2. Update https://openimis.atlassian.net/wiki/spaces/OP/pages/40665126 for https://openimis.atlassian.net/wiki/spaces/OP/pages/3211395073

  3. Create “Technical Requirements” page and fill with content e.g. https://openimis.atlassian.net/wiki/spaces/OP/pages/898924553

  4. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3077472261 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

    1. Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/290455555

    2. Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/1425473537

    3. Validate https://openimis.atlassian.net/wiki/spaces/OP/pages/619380737

    4. Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3193798657 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

    5. Integrate “Automated CI testing" of https://openimis.atlassian.net/wiki/spaces/OP/pages/3077472261 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  5. Validate and integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/3288694789 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  6. Validate YouTube content for https://openimis.atlassian.net/wiki/spaces/OP/pages/3211395073 / current development ↔︎ Dev Committee #176

Github

  1. Clarify distribution of documention between GitHub repo and Wiki and remove redundancies

  2. Clarify distribution of release notes between GitHub repo and Wiki and remove redundancies

  3. Mark/Remove/Hide deprecated GitHub repos

Architecture

  1. Reorganize structure in https://openimis.atlassian.net/wiki/spaces/OP/pages/589561955 and create overview according to https://openimis.atlassian.net/wiki/spaces/OP/pages/807698543 / https://openimis.atlassian.net/wiki/spaces/OP/pages/945422345 / https://docs.google.com/presentation/d/1eUqlOkK6MyTPZsQG3A8mZDzoIvFxzUtxi5r6UCVYYjc/edit#slide=id.g1192d288ca2_0_65 (slide 12) ↔︎ Dev Committee #105

  2. Create dependency graph for openIMIS modules / repos in https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  3. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/494338053 (e.g. https://openimis.atlassian.net/wiki/spaces/OP/pages/586383361 ) into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  4. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/606208025 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  5. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/900595717 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  6. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/945422345 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  7. Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/1445953560 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  8. Update each module in https://openimis.atlassian.net/wiki/spaces/OP/pages/589561955 ↔︎ Dev Committee #260

  9. Validate and Integrate finished Projects from https://openimis.atlassian.net/wiki/spaces/OP/pages/2058879051 into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465 (Architecture)

Release

  1. Document Release Management into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

    • step by step deliverables / check-list (integrate pull-requests, update doku, update modules overview)

  2. Update https://openimis.atlassian.net/wiki/spaces/OP/pages/368508929 for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

  3. Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/368508929 into https://openimis.atlassian.net/wiki/spaces/OP/pages/1322221610

  4. Merge / move / clean up https://openimis.atlassian.net/wiki/spaces/OP/pages/368345128 into https://openimis.atlassian.net/wiki/spaces/OP/pages/1322221610

Documentation Methodology

  1. How to document architecture: Graphics: repository for architecture etc done with draw.io

  2. Re-organize first level children of https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465 e.g. create and move content into our Technical Knowledge Base as “How-to”

  3. Validate and Integrate further mature/not-in-development content into https://openimis.atlassian.net/wiki/spaces/OP/pages/147390465

  4. Standardize naming in our Technical Knowledge Base “How to” etc. …

  5. Standardize naming in https://openimis.atlassian.net/wiki/spaces/OP/pages/215351328 substructure explicitely “openIMIS” everywhere or nowhere

Internal Documentation

under Maintenance Contract

 

GIZ internal

Taskforces

Taskforce

Involved Parties

Meetings

Taskforce

Involved Parties

Meetings

Release checklist, Server Doc (T1)
https://openimis.atlassian.net/wiki/spaces/OP/pages/3304488961

Improving technical documentation, ensuring sustainable operations

STPH, GIZ

Weekly Wed. 11-12pm

Server Administration & Accounts

Consolidate server hosting credentials, migration of DNS host and access sharing strategies

GIZ, GIZ NP

Ongoing

https://openimis.atlassian.net/wiki/spaces/OP/pages/3290923009

Optimizing accessibility to knowledge of the wiki for different target groups

GIZ

In Preparation

Modular Architecture

Document modular architecture,

GIZ, Blsq

In Preparation