You need to sign in or sign up before continuing.
Review and revamp Issues doc
Per gitlab-com/Product#75 (moved) I am reviewing and revamping this doc page/section in order to test our latest documentation style and structure standards, plus additional ideas, and arrive at the first of multiple docs that can be used as an example of these standards in action.
Takeaways:
- We just need to have one good place to link for a feature. That doesn’t mean every feature must be called out by its features.yml name in docs as a subheading, for example. This makes the doc hard to browse. Group by functionality instead (and these groups can be 'invented' by the tech writer; they just need to be logical and accurate, they don't need to exist in the UI or features.yml).
- Use large screenshots rarely, and all screenshots sparingly. The larger the screenshot, the harder it will be to read, and the more it will distract from other items in the page, making it harder to skim and maintain context. Some screenshots offer meaningful context; a valuable conceptual understanding. But too many can clutter the page. And they're hard to keep up to datee.
Next Steps:
- Create a workflow doc for the section about getting started on a new project with issues and boards.
- Review GitLab Workflow (formerly linked) to determine if up to date and worth bringing in any content or linking out
- Review subpages
Edited by Mike Lewis