If you are:
@DjevaLoperka
● trying to be an open source contributor
Slide 4
Slide 4 text
If you are:
@DjevaLoperka
● trying to be an open source contributor
● trying to be an open source user
Slide 5
Slide 5 text
If you are:
@DjevaLoperka
● trying to be an open source contributor
● trying to be an open source user
● trying to be an open source maintainer
Slide 6
Slide 6 text
Is it really needed?
@DjevaLoperka
really
Slide 7
Slide 7 text
Misconceptions:
@DjevaLoperka
Slide 8
Slide 8 text
Misconceptions:
@DjevaLoperka
● “Code should be self-documented.”
Slide 9
Slide 9 text
Misconceptions:
@DjevaLoperka
● “Code should be self-documented.”
● “It’s obvious how to use our software. Users will know.”
Slide 10
Slide 10 text
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.”
Slide 11
Slide 11 text
@DjevaLoperka
Slide 12
Slide 12 text
@DjevaLoperka
Slide 13
Slide 13 text
@DjevaLoperka
Slide 14
Slide 14 text
@DjevaLoperka
Slide 15
Slide 15 text
@DjevaLoperka
Slide 16
Slide 16 text
WordPress Docs
@DjevaLoperka
Making
Slide 17
Slide 17 text
Pros Cons
@DjevaLoperka
Slide 18
Slide 18 text
Pros Cons
@DjevaLoperka
● Everyone can edit
Slide 19
Slide 19 text
Pros Cons
@DjevaLoperka
● Everyone can edit
● One account needed
Slide 20
Slide 20 text
Pros Cons
@DjevaLoperka
● Everyone can edit
● One account needed
● Version control
Slide 21
Slide 21 text
Pros Cons
@DjevaLoperka
● Everyone can edit
● One account needed
● Version control
● Everyone can edit
Slide 22
Slide 22 text
Pros Cons
@DjevaLoperka
● Everyone can edit
● One account needed
● Version control
● Everyone can edit
● Everyone can edit
Slide 23
Slide 23 text
Pros Cons
@DjevaLoperka
● Everyone can edit
● One account needed
● Version control
● Everyone can edit
● Everyone can edit
● Everyone can edit
Slide 24
Slide 24 text
Codex New docs
@DjevaLoperka
Slide 25
Slide 25 text
Codex New docs
● Wiki ● WordPress
@DjevaLoperka
Slide 26
Slide 26 text
Codex New docs
● Wiki
● One account
● WordPress
● At least two accounts
@DjevaLoperka
Slide 27
Slide 27 text
Codex New docs
● Wiki
● One account
● Everyone can create docs
● WordPress
● At least two accounts
● Few can create docs
@DjevaLoperka
Slide 28
Slide 28 text
Codex New docs
● Wiki
● One account
● Everyone can create docs
● Maintenance nightmare
● WordPress
● At least two accounts
● Few can create docs
● Maintenance controlled
@DjevaLoperka
Slide 29
Slide 29 text
The issue of
@DjevaLoperka
reporting issues
Slide 30
Slide 30 text
End user docs:
@DjevaLoperka
Slide 31
Slide 31 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
Slide 32
Slide 32 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
Slide 33
Slide 33 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
● Two parts:
Slide 34
Slide 34 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
● Two parts:
○ General
Slide 35
Slide 35 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
● Two parts:
○ General
○ Block editor
Slide 36
Slide 36 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
● Two parts:
○ General
○ Block editor
Slide 37
Slide 37 text
End user docs:
@DjevaLoperka
● Project code name “HelpHub”
● wordpress.org/support
● Two parts:
○ General
○ Block editor
Slide 38
Slide 38 text
Developer docs:
@DjevaLoperka
Slide 39
Slide 39 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
Slide 40
Slide 40 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
Slide 41
Slide 41 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
● 8 handbooks: Code reference, Coding standards, Block editor,
Common APIs, Themes, Plugins, REST API and WP-CLI
Slide 42
Slide 42 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
● 8 handbooks: Code reference, Coding standards, Block editor,
Common APIs, Themes, Plugins, REST API and WP-CLI
Slide 43
Slide 43 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
● 8 handbooks: Code reference, Coding standards, Block editor,
Common APIs, Themes, Plugins, REST API and WP-CLI
Slide 44
Slide 44 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
● 8 handbooks: Code reference, Coding standards, Block editor,
Common APIs, Themes, Plugins, REST API and WP-CLI
Slide 45
Slide 45 text
Developer docs:
@DjevaLoperka
● Project code name “DevHub”
● developer.wordpress.org
● 8 handbooks: Code reference, Coding standards, Block editor,
Common APIs, Themes, Plugins, REST API and WP-CLI
Slide 46
Slide 46 text
Contributor docs:
@DjevaLoperka
Slide 47
Slide 47 text
Contributor docs:
@DjevaLoperka
● Team’s blog and handbook
Slide 48
Slide 48 text
Contributor docs:
@DjevaLoperka
● Team’s blog and handbook
● make.wordpress.org
Slide 49
Slide 49 text
Contributor docs:
@DjevaLoperka
● Team’s blog and handbook
● make.wordpress.org
● Contribution processes
Slide 50
Slide 50 text
@DjevaLoperka
Slide 51
Slide 51 text
@DjevaLoperka
Slide 52
Slide 52 text
The perfect tool:
@DjevaLoperka
Slide 53
Slide 53 text
The perfect tool:
@DjevaLoperka
● Reporting issues on the spot
Slide 54
Slide 54 text
The perfect tool:
@DjevaLoperka
● Reporting issues on the spot
● Not creating additional work for active contributors
Slide 55
Slide 55 text
The perfect tool:
@DjevaLoperka
● Reporting issues on the spot
● Not creating additional work for active contributors
● Automate everything
Slide 56
Slide 56 text
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
Slide 57
Slide 57 text
The transition tool:
@DjevaLoperka
Slide 58
Slide 58 text
The transition tool:
@DjevaLoperka
● A central place for reporting all issues
Slide 59
Slide 59 text
The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
Slide 60
Slide 60 text
The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
● A central place for working on any issue
Slide 61
Slide 61 text
The transition tool:
@DjevaLoperka
● A central place for reporting all issues - possibility for extending
● A central place for working on any issue - removing bottleneck
Slide 62
Slide 62 text
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
Slide 63
Slide 63 text
What about
@DjevaLoperka
Gutenberg
Slide 64
Slide 64 text
Gutenberg:
@DjevaLoperka
Slide 65
Slide 65 text
Gutenberg:
@DjevaLoperka
● PHP + React.js
Slide 66
Slide 66 text
Gutenberg:
@DjevaLoperka
● PHP + React.js
● Change will always be rejected by some
Slide 67
Slide 67 text
Gutenberg:
@DjevaLoperka
● PHP + React.js
● Change will always be rejected by some
● Documentation debt
Slide 68
Slide 68 text
The best documentation
is written by those who are
using it.
@DjevaLoperka
Slide 69
Slide 69 text
Long story short..
@DjevaLoperka
Slide 70
Slide 70 text
Moving forward:
@DjevaLoperka
Slide 71
Slide 71 text
Moving forward:
@DjevaLoperka
● Google Season of Docs 2020
Slide 72
Slide 72 text
Moving forward:
@DjevaLoperka
● Google Season of Docs 2020
● WordPress releases
Slide 73
Slide 73 text
Moving forward:
@DjevaLoperka
● Google Season of Docs 2020
● WordPress releases
● Collaborating with other teams
Slide 74
Slide 74 text
Moving forward:
@DjevaLoperka
● Google Season of Docs 2020
● WordPress releases
● Collaborating with other teams
● Paired programming / documenting
Slide 75
Slide 75 text
@DjevaLoperka
Slide 76
Slide 76 text
@DjevaLoperka
Slide 77
Slide 77 text
Resources:
@DjevaLoperka
● https://www.writethedocs.org/guide/
● https://developers.google.com/tech-writing
● https://readthedocs.org/
● https://opensource.com/resources/what-open-source
● Join WordPress community at https://make.wordpress.org/
Slide 78
Slide 78 text
WordPress engineer at XWP - We’re hiring!! 🤩
WordPress Documentation Team representative
Milana Cap
Twitter:
GitHub:
WordPress:
WordPress Slack:
Email:
@DjevaLoperka
@zzap
@milana_cap
@zzap
[email protected]
Slide 79
Slide 79 text
Milana Cap
Thank you
Twitter:
GitHub:
WordPress:
WordPress Slack:
Email:
@DjevaLoperka
@zzap
@milana_cap
@zzap
[email protected]