YoVDO

Writing Better Documentation for Developers

Offered By: EuroPython Conference via YouTube

Tags

EuroPython Courses Software Development Courses Content Marketing Courses API Documentation Courses Documentation Writing Courses

Course Description

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
Discover essential strategies for creating effective developer documentation in this 31-minute conference talk from EuroPython 2021. Learn why documentation is crucial for marketing, product definition, and user interface. Explore different types of documentation, understand the distinction between reference and API docs, and gain insights on navigating between various doc types. Recognize the importance of user feedback and public Q&A forums in improving documentation quality. Acquire practical tips to enhance your documentation skills and make your developer-focused product more accessible and user-friendly.

Syllabus

Intro
Why we care
Should you be
Content marketing
Documentation
Documentation Index
Documentation Types
Reference vs API Documentation
Javadoc Disease
Talk to Users
Questions are Patches
Documentation is your User Interface
Dog Tests
ProjectSpecific Documentation
Pull Requests


Taught by

EuroPython Conference

Related Courses

Software as a Service
University of California, Berkeley via Coursera Software Testing
University of Utah via Udacity The Hardware/Software Interface
University of Washington via Coursera Software Debugging
Saarland University via Udacity Introduction to Systematic Program Design - Part 1
The University of British Columbia via Coursera