DHIS Documentation

Welcome to the DHIS Documentation project. This space maintains all documentation relevant to the DHIS software. Here you can primarily find documentation on DHIS 2. The documentation presented is organized around different users, mainly users, administrators and developers. You will also find system documentation.

Documentation overview

• DHIS 2
  • User documentation
    • User manual: Manual on how to use the DHIS 2 application.
    • User FAQ: Common issues users might encounter.
  • Administrator documentation
    • Installing DHIS 2
    • Configuring DHIS 2
    • Design a DHIS 2 report with Report tool and iReport
    • Creating a DHIS 2 pivot table
    • Administrator FAQ: Common issues in installation and configuration.
  • Developer documentation
    • Downloading the source code: Instructions on how to retrieve the source code from our repository.
    • Building the source code: Instructions on how to build the source code.
    • Development environment and tools: A description of recommended tools and frameworks for developing, including downloading and configuring them.
      • Tools: The tools used in the developing of DHIS 2.
      • Windows
      • Linux
      • Mac
    • Development standards and conventions: A description of which standards, principles and guidelines to stick to when developing.
    • Developer FAQ
  • System documentation
    • System history: A short introduction to the evolution of DHIS, the motivation for the software and the health domain.
    • System overview: A short description of what this system is intended to do, which services it provide, and so on.
    • Concepts and techniques: An introduction to concepts such as layering, MVC, services, DAOs, inversion of control and the like.
    • Frameworks: The frameworks used in the DHIS 2 system such as Spring, Hibernate, Webwork, JUnit and the like.
    • The DHIS 2 data model: Description of the DHIS 2 model classes, such as DataElement, DataValue and the like.
    • Java API: JavaDoc of the DHIS 2 Java API.
    • Database API: Description of the database structure which lies under DHIS 2.
    • Modules
      • Overview and connections: A textual description of how the modules are connected, which depend on which and so on.
      • Import-Export Module
      • Data Provider Module
      • Module x: A description of the module, it's organization into packacges and classes, data flow, relationship to other modules and the like.
      • Module y
    • JavaDoc: External link to generated JavaDoc.
    • System FAQ
  • Mailing lists: Mailing lists and rules for use of these.
• DHIS 1.4
• DHIS 1.3
• Documentation project
  • Goals
  • Members
  • Roadmap
  • Deliverables
  • Process

The documentation project

For the purpose of this project, documentation is defined as stable documents with static information. This does not include road maps, development issues, project membership, contact information, download information and the like.

The goals of this project are the following:

• To provide a clear and unambiguous access to documentation for users, administrators and developers.
• To provide a clear and unambiguous distribution of responsibility for documentation.
• To organize the maintenance of documentation.
• To evaluate and implement tools for documentation.

Deliverables

• Documentation process document: A document describing how documentation is produced, the standards to follow and a textual description of the documentation structure.
• A documentation structure: A wiki structure and set of placeholders for organizing documentation. This must take into account different users of the documentation, such as developers, administrators and end-users. It must also take into account the relationship to other kinds of information, such as project management and support services.
• Documentation responsibility document: A document describing which persons are responsible for different types of documentation.