Help pages should be short and linked with their repestive elements in the software (contextual help). The help will later be merged into a printable manual that will include a bit more general information.
Structure and content
The help structure is similar to the LCM user-interface: each menu item is a "section" and each set of features for that section is an "article".
Section "10. Installation": (c.f. Spip)
- (almost ready) Article: 13. Setting up permissions — help_title_install_permissions
- (ready) Article: 15. Your database connection — help_title_install_database
- (ready) Article: 17. Personal information — help_title_install_personal
Section "20. Cases" — help_title_cases:
- Article: 22. Intro: Rôle of case, New case, edit case (overview of the fields) — help_title_cases_intro.
- Article: 24. Adding authors, clients and organisations to the case. Note: should describe the features related to collaborative work (many authors on one article, or review from other authors). — help_title_cases_participants.
- Article: 26. Adding new follow-ups (overview of the fields, impacts of follow-up types — some change the case status). — help_title_cases_followups.
Section: 30. Clients and organisations — help_title_clients:
- Article: 32. Intro: Rôle of client, New client, edit client (overview of the fields) — help_title_clients_intro.
- Article: 34. Intro: Rôle of org, New org, edit org (overview of the fields) Link between organisations and clients, what is a representant. — help_title_clients_org.
Secton: 35. Authors — help_title_authors
- Article: 36. Intro: Rôle of author, New author, edit author (fields). Note: should explain the role of the administrator, rights, etc. Self-registration. — help_title_authors_intro
- Article: 38. Rôle of administrator (?) — help_title_authors_admin
Section: 40. Extra tools — help_title_tools:
- Article: 42. Document upload/attachments. — help_title_tools_documents
- Article: 44. Agenda — help_title_tools_agenda
Section: 50. Site configuration — help_title_siteconfig
- (ready EN) Article: 52. General configuration — help_title_siteconfig_general
- (ready EN) Article: 54. Collaborative work — help_title_siteconfig_collab
- (ready EN) Article: 56. Office policy — help_title_siteconfig_policy
- (ready EN) Article: 58. Regional settings — help_title_siteconfig_regional
Section: 60. Archives — help_title_archives
- Article: Is there anything to say? Is implementation complete?
Section: 65. Reports — help_title_reports
- Article: 66. Rôle of reports — help_title_reports_intro
- Article: 67. Create/edit report — help_title_reports_edit
- Article: ...
Section: 70. Keywords — help_title_keywords
- Article: 72: Introduction to keywords — help_title_keywords_intro
- Article: 74: New/edit keyword groups — help_title_keywords_new_group
- Article: 76: New/edit keywords — help_title_keywords_new
Section: 80. About ...
- (ready) 85. Article: Contributors — about_contrib
- (ready) 87. Article: Copyright — about_license