From 7e650c88419d42bfc12ddf4dcaabacef24fccb4f Mon Sep 17 00:00:00 2001 From: Gustav Eek Date: Thu, 18 Jul 2013 17:52:42 +0200 Subject: Notes from July 11 added: Documentation discussion --- documentationdemands.mdwn | 33 +++++++++++++++++++++++++++++++++ index.mdwn | 1 + 2 files changed, 34 insertions(+) create mode 100644 documentationdemands.mdwn diff --git a/documentationdemands.mdwn b/documentationdemands.mdwn new file mode 100644 index 0000000..e6b79fd --- /dev/null +++ b/documentationdemands.mdwn @@ -0,0 +1,33 @@ +# Documentation Demands + +There is a need for a rework of the technical documentation of Fripost +email and network solutions. July 11, Leif-Jöran, Guilhem, and Gustav +recognised the demands on a technical documentation that are covered +by this article. + +*General demands* + +* Fripost should avoid many different systems: preferably the + association's homepage, wiki, and documentation solution should be + the same. + +*Demands for reading*. The solution should be + +* Index-able by Internet search engines +* Locally search-able, from within the solution +* Available in several potential reading formats +* Readable of line, which is being _less_-friendly (_more_-friendly) + +*Demands on writing and contributions*. The solution should be + +* Open for more than administrators to contribute +* Comment-able from also non members +* Reasonable efficient to edit offline from regular text editors + +## Questions to be answered + +Does _Gitolite_ have support for LDAP? That way _ikiwiki_ could be +coupled to layers of access: administrators, members, and all. + + + diff --git a/index.mdwn b/index.mdwn index 139222f..d823516 100644 --- a/index.mdwn +++ b/index.mdwn @@ -23,6 +23,7 @@ Välkommen till Friposts medlemswiki! # Tekniskt * [[Hemsidan]] – hur den fungerar +* [[Dokumentationskrav|documentationdemands]] – krav på lösning för tekninsk dokumentation # Övrigt -- cgit v1.2.3