...

Each VIVO document consists of a large number of wiki pages. These pages must work well together, both on the wiki and when exported to a PDF file. Here are some suggestions to help that happen.

...

Keep Pages to Manageable Size

Keep each page to a manageable size, and focused on a particular topic. If you find that the page is too complex or too diverse, break it into smaller pages. Within each group of pages, the parent should contain introductory material or an overview, while the child pages explore individual topics.

...

The technical documentation is version specific.  The text you write should focus on the current version.  Historical notes regarding how things were done in earlier versions are mostly out of place in the technical documentation.  Pages introducing new features may have historical notes that indcate how things were done in previous versions.

Use Code Block Macros

Use a code block macro to represent code.  A title for the code block is optional.

Use monospace in sentences to represent code.

...

Be Careful with Links

Links in the technical documentation wiki need to be checked to make sure they are referring to other parts of the tech doc, or external sources.  Links to pages in the project wiki are “okay” but need to be done carefully -- such links are often red flags that the tech doc is drifting into content better suited for the project wiki.  Links to the archive should be avoided.  Content from the archive that is relevant for the current version should be copied into the documentation wiki.

...