Public Facing

General

• Wikistructure

  • Restructure the documentation landing page: Documentation

  Sandbox Landscape :

  • (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 -

  Application Releases

Users

• User documentation:

  • 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

    • https://jira.atlassian.com/browse/CONFCLOUD-74361

• Web-Page

  • Introduce issue queue for web-maintenance → https://openimis.atlassian.net/jira/software/c/projects/OOW/boards/23

  • Maintain /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/

  • which platform for user docs? readthedocs (current standard, but outdated)? gitbook? wiki?

• Updated FAQ List

Implementers

...

Todo: Define Use Cases

...

Installation instructions: Installation and Country Localisation

Developers

• List/structure of modules needs to be set up: refer

  • 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 Generic Implementation Starter Kit into Documentation

  • Update Resource requirements

• 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 Modular Migration: Open Issues)

• Create “How to update from version / release x to version / release y” tutorial

• ValidateQuality assurance and Document Testing Scenarios ↔︎ Dev Committee #223

• Validate and Integrate openIMIS Integrations into Documentation

• Validate and Integrate Sandbox Landscape into openIMIS Product

• Validate and Integrate Translation Management platform into Documentation

• Validate and Integrate JIRA reports into openIMIS Product

• Validate and Integrate Issue tracking into openIMIS Product

• Validate and Integrate Use cases served by openIMIS - overview into Documentation

Developers

Development guidelines

• Update Developer Starter Kit for Release 2022-04

• 🧑‍🏭 Update Installation Guide for Release 2022-04

• ⚠️ Create “Technical Requirements” page and fill with content e.g. Connectivity & theoretical infrastructure required

• Validate and Integrate code and publishing management into Documentation

  • Validate Version management

  • Validate Contribution guidelines

  • Validate Extended Github workflow

  • Integrate Updating all python modules CI github workflow into Documentation

  • Integrate “Automated CI testing" of code and publishing management into Documentation

• ⚠️ Validate and integrate UI/UX Style Guide into Documentation

• Validate YouTube content for Release 2022-04 / current development ↔︎ Dev Committee #176

  • Merge YT-Playlists https://www.youtube.com/playlist?list=PLWKJKsJBiT3I0kPxDEjiOpT6_sX01pl3Q and https://www.youtube.com/playlist?list=PLWKJKsJBiT3LlFCac1D7yQqj-AbSGD4ic

• Validate and update Functional specification / Technical documentation

• Integrate code documentation in Wiki (see 2022-07-28 Developers Deep Dive Call )

• Setup a “Source Code Opportunities” page where software solutions of projects like Project: MARS Software Lab, the solution of Bluesquare in Nepal or other prototypes / proof of concepts can be put, maintained and referred to, to be taken up and being further developed

Github

• Clarify distribution of documentation between GitHub repo and Wiki and remove redundancies

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

• ⚠️ Mark/Remove/Hide deprecated GitHub repos

• Provide license information in every repository

Architecture

• Rework/create documentation of modular architecture Modular Architecture [Notes]

• Reorganize structure in openIMIS Modules and create overview according to The JLN Process Matrix / JLN Process - OpenIMIS Mapping / https://docs.google.com/presentation/d/1eUqlOkK6MyTPZsQG3A8mZDzoIvFxzUtxi5r6UCVYYjc/edit#slide=id.g1192d288ca2_0_65 (slide 12) ↔︎ Dev Committee #105

• openIMIS Software Components - Download

• Graphics: repository for architecture etc done with draw.io

  • /wiki/spaces/SB/pages/3244916739

• release management - Definition of Done

  step

  Create dependency graph for openIMIS modules / repos in Documentation

• Validate and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation

• Validate and Integrate Target Technology Stack into Documentation

• Validate and Integrate (new) openIMIS installations into Documentation

• Validate and Integrate JLN Process - OpenIMIS Mapping into Documentation

• Validate and Integrate openIMIS Database Design into Documentation

• Update each module in openIMIS Modules

  • Create a link to the code documentation ↔︎ Dev Committee #260

  • Clarify options for configuration and/or customization of a module ↔︎ Dev Committee #274 and #288

• Validate and Integrate finished Projects from Project Portfolio into Documentation (Architecture)

Release

• Document Release Management into Documentation

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

Issues

• Outdated user documentation (Different Styles)

• GitHub-Documentation Redundancies

• youtube channel - how to keep it in synch with recent developments?

• GitHub (Modules, Repositories?) → Remove/mark depreciated

• Hide Legacy as much as possible

...

• • ->Checklist for Release 2022-10

• Update Sources for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

• Integrate Sources into Releases

• Merge / move / clean up Release notes into Releases

• Setup / optimize a documentation update process (checklist) to ensure the documentation improves in a timely and parallel way

Documentation Methodology

• ⚠️ How to document architecture: Graphics: repository for architecture etc done with draw.io

  • /wiki/spaces/SB/pages/3244916739

• Re-organize first level children of Documentation e.g. create and move content into our Technical Knowledge Base as “How-to”

• Validate and Integrate further mature/not-in-development content into Documentation

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

• Standardize naming in openIMIS Product substructure explicitly “openIMIS” everywhere or nowhere

• Include Domain Knowledge into Wiki Target Structure [Draft]

• Setup Process for Transform Product Owner / Incubator Knowledge to Documentation

• Setup Framework to Improve Recording, Documentation and Publishing of Webinars

  • Enable the process to be started externally (e.g. per Jira queue)

Internal Documentation

Under Maintenance Contract

• Project: 2020.T1 Maintenance

...

• Sandbox Server access / root accountkeypass

• Consolidate server hosting credentials, migration of DNS host and access sharing strategies -> Server Administration & Accounts

• Clean up DNS Records

• Keypass keyrings:

  • admin Admin (on internal teams channel)developers (on Google drive?)

  • Others on demand

GIZ internal

• server Server contract login (keypass keyring)DNS is still on cloudflare → HetznerKeypass keyring)

• Web-page - Wiki links: /wiki/spaces/SB/pages/1025015809

• Remove / document / avoid content redundancies between web and wiki

• ➡️ Make sure the transition from web to Wiki is smooth (especially for first time users)

• 🧑‍🏭 Clean up Teams channels (List, messages, export)

• Analyze back-links from Wiki to Web - e.g. Chad (and other implementations) refers to http://openimis.org/tanzania on the web

• ➡️ Publish relevant Events on Web

• Remove [delete] Welcome to the openIMIS Initiative! and other redundant content after launch of new version of Web

Guiding Principles

• Separate static from temporal content

• Remove and avoid redundancies

Taskforces