Topic on Talk:Technical Community Newsletter

New documentation guide for Tool docs

1
Summary by TBurmeister (WMF)

I added this to the April newsletter since it has a Hackathon-related element, so July would be too late.

TBurmeister (WMF) (talkcontribs)

For the next issue of the Technical Community Newsletter, I'd like to share the following:

The WMF Technical Documentation team has published a new guide to help tool developers create and improve documentation: Documentation/Tool docs. This guide covers the basics of how to document your tool, from creating a user guide to adding a README and commenting your code. It provides links to doc templates and examples of documentation from real Wikimedia tools. Check it out, and consider joining the Doc Your Tool project for the 2024 Hackathon!