maintaining existing docs - Dashboard
1,059
visibility Viewed
19
Total Responses
19
flag Completed
100%
timelapse Completion Rate
0
do_not_disturb_on Dropouts
1 hr
access_time Average Time
 
Countries Responses
US 47.37%
CN 10.53%
IN 10.53%
AU 5.26%
BY 5.26%
DE 5.26%
ES 5.26%
GG 5.26%
SE 5.26%
Total 100.00%
Of the strategies mentioned, which are the top 3 *best* techniques for maintaining existing documentation?
Answer Count Percent
20% 40% 60% 80% 100%
1. Define priority docs 16 27.59%
2. Identify broken links 5 8.62%
3. Identify broken or outdated images 2 3.45%
4. Delete unused branches 0 0%
5. Identify unpublished files 2 3.45%
6. Identify files or doc sets ready for deletion 3 5.17%
7. Identify content owners for each doc set 7 12.07%
8. Identify last-reviewed dates 1 1.72%
9. Require content owners to periodically review docs 6 10.34%
10. Identify docs that are missing metadata 1 1.72%
11. Identify top articles in knowledge bases that aren’t in the documentation 8 13.79%
12. Identify docs with the highest bounce rate and shortest visit time 2 3.45%
13. Review doc commit logs to check commits from people you don’t recognize 1 1.72%
14. Check engineering commit dates against release notes 1 1.72%
15. Look for broken documentation formatting 3 5.17%
Other 0 0%
Total 58 100%
Of the strategies mentioned, which are the top 3 *best* techniques for maintaining existing documentation? - Text Data for Other
No Data To Display
What am I missing from this list of documentation maintenance activities?
01/18/2021 96453760 Replace words with videos where it makes sense and Delete inane tasks and look for opportunities to include better in context guidance
11/03/2020 87244844 Have documentation included in the regular development cycles -> documentation must be updated before / shortly after any release, also small bug fix releases
11/02/2020 87073618 Visit user forums to learn about recurring user pains and try to address them in the documentation. I know that this should be support's responsibility but often support guys just answer the question without realizing that it's worthwhile letting technical writer know about it.
11/01/2020 87069149 We have broken images built into our CI/CD process. The docs won't merge if there are broken image links. (However, it doesn't fix the issue of outdated images.) Also, our metrics include terms searched in our docs search function. If a term/group of related terms shows up frequently and we already have content about it, it's a flag to us to improve our SEO on those pages and also make sure the content is up to date.
11/01/2020 87029316 In my case, I now own an implementation guide that had many guide owners before. So there are duplicate content/topics in this guide. Identifying and removing the duplicate content is quite an issue for documentation maintenance.
10/30/2020 86896725 ? Validation of Word docs - styles, etc.?
10/30/2020 86864734 ?
Do you timestamp your files with a "last modified date" and a "last reviewed date" (or something similar)?
Answer Count Percent
20% 40% 60% 80% 100%
Yes 10 52.63%
No 4 21.05%
Sometimes 3 15.79%
Other 2 10.53%
Total 19 100%
Do you timestamp your files with a "last modified date" and a "last reviewed date" (or something similar)? - Text Data for Other
11/10/2020 88375296 Files are uploaded to a platform that maintains versions and time stamps them.
11/01/2020 87029316 The documentation system does it for me.
Do you have a process for periodically flagging stale content and notifying owners to review the docs?
Answer Count Percent
20% 40% 60% 80% 100%
Yes 2 11.11%
No 14 77.78%
Sort of 1 5.56%
Other 1 5.56%
Total 18 100%
Do you have a process for periodically flagging stale content and notifying owners to review the docs? - Text Data for Other
10/30/2020 86896725 no idea - contractor, short term
What metadata do you store with each of your documentation pages?
Answer Count Percent
20% 40% 60% 80% 100%
Title 14 22.22%
Description 9 14.29%
Keywords 8 12.7%
Last modified 9 14.29%
Last reviewed 4 6.35%
Content owner 9 14.29%
Content reviewers 1 1.59%
Last translated 1 1.59%
Taxonomy term 2 3.17%
Priority 2 3.17%
Popularity 1 1.59%
Other 3 4.76%
Total 63 100%
What metadata do you store with each of your documentation pages? - Text Data for Other
01/28/2021 98136730 Version
10/30/2020 86896725 vaires - some of the above sometimes
10/30/2020 86864734 Date Created, Version, Language, Type