Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D Documentation
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 1
    • Merge requests 1
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • CastellumCastellum
  • Documentation
  • Issues
  • #21
Closed
Open
Issue created Feb 23, 2021 by Bengfort@bengfortOwner

Screenshots

Adding screenshots to documentation is tricky because it can be helpful, but it also has some major drawbacks. I tried to read up on the subject and found some useful resources:

  • https://writing.stackexchange.com/questions/10643/when-is-a-screenshot-really-useful-in-training-documentation
  • https://developer.gnome.org/gdp-style-guide/stable/infodesign-8.html.en#infodesign-10
  • http://user-assistance.blogspot.com/2009/10/screen-shots-in-documentation.html

With those in mind I propose the following policy for screenshots:

  • The overview should contain a screenshot that is representative of castellum as a whole
  • Screenshots should be used (sparingly) for guides to reassure users that they are in the correct location
    • cluster guides
    • only if the screenshot is easily recognizable
  • Screenshots should be used (sparingly) for guides to illustrate complex or unfamiliar interactions
  • Screenshots only support the text, never replace it
  • Screenshots should be taken
    • without the yellow "demo mode" banner
    • with the sample AttributeDescriptions
    • with an admin user or, if relevant for the specific case, with the relevant demo user
    • preferably of the whole page
    • in english (german translation might be added later)
Edited Feb 24, 2021 by Bengfort
Assignee
Assign to
Time tracking