Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    • Switch to GitLab Next
  • Sign in / Register
  • D dada-core
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 57
    • Issues 57
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 2
    • Merge requests 2
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • madada-teammadada-team
  • dada-core
  • Issues
  • #86
Closed
Open
Issue created Oct 16, 2021 by Laurent Savaëte@LaurentSOwner

3.3.1 Develop and maintain documentation for users and administrations

Write and maintain documentation for:

  • end users (users making requests or reading information on the site)
  • public bodies (people replying to requests)

Comments from mySociety:

I don’t know what the best approach for end-user documentation is. It seems to make sense to distribute “how to” content with Alaveteli (e.g. https://github.com/mysociety/whatdotheyknow-theme/blob/master/lib/views/help/pro. html.erb / https://www.whatdotheyknow.com/help/pro), but that makes it difficult to change and once changed, difficult to incorporate updates. On the other hand, more policy-related content seems quite site-specific.

Related Alaveteli issues:

  • The help pages are too hard to update
  • Make help pages searchable
  • Improve navigation of help pages
  • Add index to long help pages
Edited Nov 18, 2021 by Edlira Nano (Eda)
Assignee
Assign to
Time tracking