Skip to content
This repository has been archived by the owner on Oct 20, 2023. It is now read-only.

Optimize start page of manuals #89

Closed
sypets opened this issue Jun 12, 2019 · 1 comment
Closed

Optimize start page of manuals #89

sypets opened this issue Jun 12, 2019 · 1 comment
Assignees
Labels
Doing Assignee is currently working on this.

Comments

@sypets
Copy link
Contributor

sypets commented Jun 12, 2019

We have already been changing the start pages of some manuals. This should be optimized and documented.

General:

  1. What should be on start page?
  2. What should no longer be on start page?
  3. What is important? What should be on top?
  4. Which information should be grouped together?

Once this is defined, we can figure out how to style this:

  1. Should an image be added?
  2. How to style / group information

Related:

@sypets sypets self-assigned this Jun 12, 2019
@sypets sypets added this to To do in Content structure via automation Jun 12, 2019
@sypets sypets added this to To do in Improve usability, navigation, findability via automation Jun 12, 2019
@sypets
Copy link
Contributor Author

sypets commented Jun 12, 2019

Should these we on start page or elsewhere?

  • what documentation is about
  • what type of manual, e.g. extension manual, tutorial, guide
  • official documentation / community documentation
  • target audience, e.g. developers, integrators, editors, ...
  • experience level: beginner / intermediate / advanced / expert

What should no longer be on start page?

  • duplicate information, like
    • date / time last rendered (already in footer)
    • copyright (already in footer)
    • email? (already in Related links: Contact)

maybe:

  • version? (already in menu - this is not the case on mobile!)
  • author? (already in footer - from copyright text)

Not sure if everything should go on start page, but it could be grouped like:

  • meta information (about guide), e.g. licence, credit etc.
  • information about editing this guide (for doc contributors)

examples

enonic

typo3-explained

@sypets sypets added the Doing Assignee is currently working on this. label Jun 13, 2019
@sypets sypets closed this as completed Dec 26, 2020
Content structure automation moved this from To do to Done Dec 26, 2020
Improve usability, navigation, findability automation moved this from To do to Done Dec 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doing Assignee is currently working on this.
Projects
No open projects
Development

No branches or pull requests

1 participant