Contribute Media
A thank you to everyone who makes this possible: Read More

How to Make a Docs Site: Shortcuts for Busy Devs

Description

Joanna Jablonski's talk, "How to Make a Doc Site," offers practical advice on creating documentation sites that are easy to set up, maintain, and use. Joanna, an experienced educator in the Python community, emphasizes treating documentation like code—using tools such as issue trackers, version control, and static site generators like Docusaurus or MKDocs. She highlights the importance of structuring docs by user tasks and employing user-friendly language and SEO practices. Joanna also stresses writing clarity, focusing on reader needs, and using skimmable formats like vertical lists. The talk provides essential tips on tools, information architecture, and writing techniques to help developers create effective documentation sites.

Details

Improve this page