#123 - Create Great Documentation
GeeksBlaBla

#123 - Create Great Documentation

📅 21 juillet 2022 ⏱ 1:29:18
#123 - Create Great Documentation
0:00
1:29:18

À propos de cet épisode

<p>In today's episode we dive into documentation, its rules, ethics, best practices and some tools that help to get started.</p>
<h2 id="guests">Guests</h2>
<ul>
<li><p><a href="https://twitter.com/BadQuinn3">Omaima Khalil</a></p></li>
<li><p><a href="https://twitter.com/laytoun">Mohammed Aboullaite</a></p></li>
</ul>
<h2 id="notes">Notes</h2>
<p>0:00:00 - Introduction and welcoming</p>
<p>0:01:30 - Guests Introduction</p>
<p>0:02:50 - What is Documentation? Why we need it?</p>
<p>0:05:51 - What are the types of Documentation you know?</p>
<p>0:10:01 - Who do we write documentation for?</p>
<p>0:15:35 - What makes good documentation?</p>
<p>0:20:34 - Ethics of documentation and rules to respect</p>
<p>0:24:31 - How do we structure our documentation?</p>
<p>0:53:07 - What types of documentation should focus on writing?</p>
<p>1:02:20 - Some tools you use to write or share documentation.</p>
<p>1:10:00 - Tips from guests.</p>
<p>1:14:00 - GeeksBlabla Giveaway.</p>
<p>1:17:45 - Geeksblabla Picks</p>
<p>1:29:18 - Conclusion</p>
<h2 id="links">Links</h2>
<ul>
<li><a href="https://developers.google.com/tech-writing/one">Technical Writing One introduction</a></li>
<li><a href="https://www.bookstackapp.com/">Bookstack</a></li>
<li><a href="https://docusaurus.io/">Docusaurus</a></li>
</ul>
<h2 id="preparedandpresentedby">Prepared and Presented by</h2>
<ul>
<li><a href="https://twitter.com/_iMeriem">Meriem Zaid</a></li>
</ul>

Discussion 0

Chargement des commentaires...