The documentation toolkit is a set of processes and templates that you can use to create, maintain, and improve Wikimedia technical documentation.
Improve individual docs
Use checklists to review key quality indicators like content structure, accuracy, writing style, clarity, and accessibility.
A short review process including the most important standards for good documentation
A complete, detailed process to help you improve documentation content and organization
A review process focused on writing and style
Improve a collection of docs
Follow this process to audit a collection of docs and identify key areas for improvement.
Define your audience and scope your topic.
Understand the documentation landscape and how your topic relates to others.
Focus and scope your doc improvement work.
Determine the improvements necessary to address information overload, gaps, and doc maintenance challenges.
Use templates to create documentation
Use doc outlines to create quality documentation for different content types.
Write a how-to guide that describes the steps to use a technology or to solve a real-world problem. Ensure that headings are task-oriented and examples are tested for accuracy.
Create documentation for REST APIs.
Document how users should get started with or contribute to a library.
Document the reasoning behind decisions.
Questions and feedback
To ask a question or share feedback, leave a comment on the discussion page.