A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Technical project name | Improve Article Discoverability in WordPress HelpHub Documentation | ||||||||||||||||||||||||
2 | ||||||||||||||||||||||||||
3 | Project summary | I started by creating a master document that listed all of the supporting documentation relevant to the project. This document was a helpful resource to which I frequently referred. My mentors and I kicked off the project with a video conference. Mentor @estelaris suggested we split the review of the HelpHub articles listed on the List of Pages tab. This was the first step to assess the titles for accuracy and adherence to the new pillars and categories. | ||||||||||||||||||||||||
4 | Description of work completed | Without reviewing all of the articles, I would not have had the full scope when comparing the proposed titles against the pillar categories, so I suggested reviewing all of the ~200 articles. I proposed two style formatting suggestions: * Create a consistent capitalization style (sentence or title case) for article titles (accepted) * Create a consistent article title structure, such as ‘action + object’ (accepted) I revisited the already reviewed articles and updated them to align with the new styles. I continued reviewing articles and noted the following issues when I encountered them: * Spacing (too much or missing) * Grammatical * Typos * Duplicate and overlapping content (I suggested combining some articles) All recommendations are listed in the Working File - WordPress HelpHub Article Categories spreadsheet, as follows: * HelpHub title suggestions are found on the Title Change Suggestions tab * Block editor article title suggestions are noted on the Block Editor tab * Typos, grammatical and spacing issues, duplicate and/or overlapping content questions are listed on the Content Outdated tab | ||||||||||||||||||||||||
5 | Current state/next steps | 1. The Docs team reviewed and accepted/rejected the suggestions on the Content Outdated tab (see Comments column) 2. The Docs team will review the suggestions on the two other tabs 3. I will review the pillars and groupings on the New Classification Recs tab and propose changes. My mentors and I reviewed the tab a week ago and made initial edits. | ||||||||||||||||||||||||
6 | Challenges and learnings | I brought a new perspective and fresh eyes. This may have helped me spot issues that were initially missed, but as a newbie I lacked the context and knowledge that is gained over time on a project. A few times during the process, I doubted whether I was on the right track. If my issue was something I could look up, I searched for answers. If not, I reached out to my mentor @estelaris. She responded quickly, even created a Slack channel and added members of the Docs team to discuss. Reading all the HelpHub articles gave me a broad understanding that enabled me to spot issues but the process took time. I resisted the urge to conduct thorough edits on the articles - that wasn’t my role - but I noted typos and other grammatical issues for the team to review. The list of block editor articles for review arrived late in the process. I completed the review of all 68 articles but I had to move fast and didn’t have the time to thoroughly absorb the content. I’m grateful for the opportunity to contribute to WordPress on this project. I’ve learned a great deal, enjoyed working with my mentors and the Docs team, and will stay on with the team. I’m very interested in the user journey - how it succeeds and where it can fail. We technical writers can get bogged down in the writing and forget about our audience. To prevent this from happening, I asked the same questions: does this title reflect the content that follows? Does the content reinforce the action + object promised in the title (such as Embed Youtube videos)? The answers helped me make constructive title recommendations. | ||||||||||||||||||||||||
7 | ||||||||||||||||||||||||||
8 | ||||||||||||||||||||||||||
9 | ||||||||||||||||||||||||||
10 | ||||||||||||||||||||||||||
11 | ||||||||||||||||||||||||||
12 | ||||||||||||||||||||||||||
13 | ||||||||||||||||||||||||||
14 | ||||||||||||||||||||||||||
15 | ||||||||||||||||||||||||||
16 | ||||||||||||||||||||||||||
17 | ||||||||||||||||||||||||||
18 | ||||||||||||||||||||||||||
19 | ||||||||||||||||||||||||||
20 | ||||||||||||||||||||||||||
21 | ||||||||||||||||||||||||||
22 | ||||||||||||||||||||||||||
23 | ||||||||||||||||||||||||||
24 | ||||||||||||||||||||||||||
25 | ||||||||||||||||||||||||||
26 | ||||||||||||||||||||||||||
27 | ||||||||||||||||||||||||||
28 | ||||||||||||||||||||||||||
29 | ||||||||||||||||||||||||||
30 | ||||||||||||||||||||||||||
31 | ||||||||||||||||||||||||||
32 | ||||||||||||||||||||||||||
33 | ||||||||||||||||||||||||||
34 | ||||||||||||||||||||||||||
35 | ||||||||||||||||||||||||||
36 | ||||||||||||||||||||||||||
37 | ||||||||||||||||||||||||||
38 | ||||||||||||||||||||||||||
39 | ||||||||||||||||||||||||||
40 | ||||||||||||||||||||||||||
41 | ||||||||||||||||||||||||||
42 | ||||||||||||||||||||||||||
43 | ||||||||||||||||||||||||||
44 | ||||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | ||||||||||||||||||||||||||
48 | ||||||||||||||||||||||||||
49 | ||||||||||||||||||||||||||
50 | ||||||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 |