Loading…
Gitlab Virtual Contribute 2020 has ended
Thursday, April 23 • 18:00 - 18:45
Documentation: basics and tips that make it easier LIMITED

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.
Limited Capacity seats available

Workshop issue

While GitLab has a growing technical writing team, the first drafts of docs are usually created by our wonderful engineers. Some engineers enjoy writing docs, some are nervous about it, some find it a chore, and some even hate it (and that's ok!). I (We?) will go over some basics (many of which are in our documentation guides, but are good to review), as well as give tips and recommendations. I hope this helps everyone be more comfortable with writing out the docs (or at least hate writing docs less). If time allows, I will also give a brief overview of how the docs go from markdown in the gitlab repo, to html on docs.gitlab.com.
  • Intended Audience: Engineers that work on features, and thus have to document how to use those features, as well as Support team members, and anyone else that wants to contribute improvements to our documentation.
  • Presentation, with some group discussion.
  • Add your questions here: https://docs.google.com/document/d/1HCsEI0HaEoXG83z8rKgiGC07HxKwAW6GUeWxUugoLJY/edit?usp=sharing


Speakers
avatar for Marcel Amirault

Marcel Amirault

Technical Writer, GitLab


Thursday April 23, 2020 18:00 - 18:45 PDT
TBA