Problem
Documentation is out of date, incomplete (T2001)
Wikimedia produces a large number of FLOSS software products targeted at various audiences. The audiences need documentation in the form of tutorials, API references, platform overviews, etc to effectively use and extend the products. MediaWiki itself is a highly extensible platform for creating solutions for collaborative, open sharing of information. Sadly, this platform itself is under-documented which slows down the rate at which developers can produce innovative solutions based on it. "Read the source code" is not an acceptable way to gain an initial understanding of a product offering, but many software developers lack the time, motivation, and skills needed to effectively and completely document the solutions they produce. Improved technical documentation of the internal and external interfaces that can be used to extend or programmatically consume MediaWiki hosted content should make use and development easier for existing and future technical contributors.
Solution
Create special interest group in charge of:
- Triaging/grooming the Documentation workboard.
- Identifying top priorities based on impact and interest.
- Organizing activities (including lobbying to the Wikimedia Foundation) in order to complete the top priorities.
- Attracting people interested in working on documentation.
- Connecting documentation volunteers with people and projects who can help get them started.
- Advocating documentation best practices for Wikimedia products.
- Developing resources to make contributing technical documentation easier.
See also