maintaining existing docs - Dashboard
1,230
visibility
Viewed
20
Total Responses
20
flag Completed
100%
timelapse Completion Rate
0
do_not_disturb_on Dropouts
1 hr
access_time Average Time
| Countries | Responses |
|---|---|
| US | 45.00% |
| IN | 10.00% |
| CN | 10.00% |
| DE | 5.00% |
| ES | 5.00% |
| GG | 5.00% |
| SE | 5.00% |
| AU | 5.00% |
| BY | 5.00% |
| VN | 5.00% |
| Total | 100.00% |
Of the strategies mentioned, which are the top 3 *best* techniques for maintaining existing documentation?
| Answer | Count | Percent |
|
1. Define priority docs | 16 | 26.23% |
|
2. Identify broken links | 6 | 9.84% |
|
3. Identify broken or outdated images | 2 | 3.28% |
|
4. Delete unused branches | 0 | 0% |
|
5. Identify unpublished files | 2 | 3.28% |
|
6. Identify files or doc sets ready for deletion | 3 | 4.92% |
|
7. Identify content owners for each doc set | 8 | 13.11% |
|
8. Identify last-reviewed dates | 1 | 1.64% |
|
9. Require content owners to periodically review docs | 7 | 11.48% |
|
10. Identify docs that are missing metadata | 1 | 1.64% |
|
11. Identify top articles in knowledge bases that aren’t in the documentation | 8 | 13.11% |
|
12. Identify docs with the highest bounce rate and shortest visit time | 2 | 3.28% |
|
13. Review doc commit logs to check commits from people you don’t recognize | 1 | 1.64% |
|
14. Check engineering commit dates against release notes | 1 | 1.64% |
|
15. Look for broken documentation formatting | 3 | 4.92% |
|
Other | 0 | 0% |
|
|---|---|---|---|---|---|---|---|---|
| Total | 61 | 100 % |
Of the strategies mentioned, which are the top 3 *best* techniques for maintaining existing documentation? - Text Data for Other
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 |
|
Yes | 10 | 50% |
|
No | 4 | 20% |
|
Sometimes | 3 | 15% |
|
Other | 3 | 15% |
|
|---|---|---|---|---|---|---|---|---|
| Total | 20 | 100 % |
Do you timestamp your files with a "last modified date" and a "last reviewed date" (or something similar)? - Text Data for Other
| 09/14/2021 | 125944296 | Confluence does this for me |
| 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 |
|
Yes | 2 | 10.53% |
|
No | 14 | 73.68% |
|
Sort of | 2 | 10.53% |
|
Other | 1 | 5.26% |
|
|---|---|---|---|---|---|---|---|---|
| Total | 19 | 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 |
|
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 |
Loading...
