Documentation: the Why, the How, the Do It Now!

44:28
53
1
0
0
0
Share
Feb 22, 2020

If someone were to join your team today, how quickly would they be able to ramp up? Would they be able to hit the ground running or would they keep tripping over the unspoken quirks of your system? Having a documentation can solve many problems before they arise. Whether you are a team of one or one thousand, having a good, current reference of the whys and hows of your system can save you a lot of headaches down the line. In this talk, we will discuss the benefits of having good docs and the potential risks and costs of the alternative; as well as tips and resources to get you started. Attendees will leave this session with... - An overview of different types of documentation and their most effective used cases and audiences - Techniques for writing and maintaining good documentation - Arguments to get teams on board with making documentation part of their process Documentation extends beyond the question of "What does this code do?" As such, attendees of all levels and roles can benefit from this session.

Qymana Botts
Software Engineer at Nerdery
Armed with an arsenal of programming languages, about 6 or 7 musical instruments, and a comically robust knowledge of video game lore, Qymana Botts is a quirky, enthusiastic dev on a quest to contribute a verse to this powerful play. Formerly a globetrotting music teacher, she made the transition to tech in 2017. Now, she works as a Software Engineer at Nerdery in Chicago. She is also an IAAP Certified Professional in Accessibility Core Competencies (CPACC).

https://www.fldrupal.camp/sessions/beginner-track/documentation-why-how…

Hi! I'm Karim Boudjema, the developer and site-builder of this site.

I was wondering how could I giving back to the Drupal community all what it gave to me during the last 10 years, that's how the idea of this site came to me ... (read more)

Hi! I’m Santiago Rico, the web designer and themer of this site.

When Karim proposed me to design and theme this site for the Drupal community, I accepted immediately because the community is the main reason why I love Drupal so much.