Protohaven Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Features to Consider for Technical Solutions =====

==== Separation of Concerns ====

The information will be easier to manage if we consolidate information based on audience.

An example plan:

  * Manage and contain all of the public-facing information on the public-facing website. Update the static material as needed with an editorial process, and pull dynamic material from APIs.
  * Keep member-facing content on an private system that supports easy editing (Wiki, etc.). This information should //not// be automatically promoted to the public website (putting stuff into the public sphere should have more checks).
  * Use access control to partition the private system (read and/or write access ass appropriate)

==== Access Control ====

Everything on the public website should be published with the expectation that it is public information, no access control needed. (Protected sites can be linked to)

A private system (wiki, etc.) with appropriate access controls would support giving access to parts of the system to particular groups:

  * Material that is read/write for everyone (collaborative documents, general documentation)
  * Material that is read for everyone, but write for a select group (policy documents)
  * Material that not everyone has read access to (drafts)  

==== Editing ====

Concerns have be expressed about ease of use for non-technical users - make sure a path to editing is available that all interested parties can comfortably use.

==== Staging ====

There should be a way to view a draft version for editing and comment //before// the documentation is published for use.

==== Document Design ====

If documentation is to be placed on the web, it should support reasonable search and navigation (toc, breadcrumbs (path to document), appropriate use of HTML tags to support accessibility).

If documentation is to be printed, it should support page numbering, a table of contents, and good markings in the headers and footers.

Figures should be captioned for reference and clarity.

==== Governance ====

The private system should keep track of editing history (who made changes to a document, when they did it, and what changed).

Also useful is a system to track the age of documents in the system, and flag old documents for review (could be a tech task?)