The document discusses WordPress documentation and the process for improving it. It notes that WordPress documentation includes end user docs on wordpress.org/support, developer docs on developer.wordpress.org, and contributor docs on make.wordpress.org. It also discusses misconceptions around documentation, using GitHub for reporting issues, and Google Season of Docs for improving documentation in 2020. The document advocates for collaborating across teams and using paired programming/documenting to improve WordPress documentation.
10. Misconceptions:
@DjevaLoperka
● “Code should be self-documented.”
● “It’s obvious how to use our software. Users will know.”
● “Real developers write code and have no time for docs.”
26. Codex New docs
● Wiki
● One account
● WordPress
● At least two accounts
@DjevaLoperka
27. Codex New docs
● Wiki
● One account
● Everyone can create docs
● WordPress
● At least two accounts
● Few can create docs
@DjevaLoperka
28. Codex New docs
● Wiki
● One account
● Everyone can create docs
● Maintenance nightmare
● WordPress
● At least two accounts
● Few can create docs
● Maintenance controlled
@DjevaLoperka
55. The perfect tool:
@DjevaLoperka
● Reporting issues on the spot
● Not creating additional work for active contributors
● Automate everything
56. The perfect tool:
@DjevaLoperka
● Reporting issues on the spot
● Not creating additional work for active contributors
● Automate everything
● Doesn’t exist but GitHub will do
60. The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
● A central place for working on any issue
61. The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
● A central place for working on any issue - removing bottleneck
62. The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
● A central place for working on any issue - removing bottleneck
● Contribution recognition