Documentation guidelines

The documentation is currently hosted on a dedicated repository:

https://github.com/informatici/openhospital-doc

And all changes follow the same contribution workflow as Jira issues.

In order to keep up to date as much as possible the documentation, we require that the dev himself/herself is the one in charge to update it along with a new feature/bug/improvement development.

The documentation should be brief and furnished with relevant screenshot, following the current flavor (chapters and formatting) and these simple rules:

• use “impersonal form” (avoid "you", prefer “one”)

• use “active voice” form (see Active voice vs. passive voice  |  Technical Writing  |  Google Developers )

• always actual (avoid "since version X.Y.Z")

• use "Open Hospital" (with space) or "OH"

Formatting:

• leverage the AsciiDoctor (.adoc) formatting rules (see https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/ )

• buttons, windows, notes: just imitate what you find nearby the chapter you are modifying

When an issue involves also the documentation, you will see:

• the oh-doc component involved

• the documentation tag/label

• a DOCUMENT and DOC REVIEW dedicated statuses

• sometimes also a light blue banner in the description like this one

Open