How do you keep your software documentation skills current and relevant?

1 Learn from others

One of the best ways to improve your software documentation skills is to learn from other software documentarians. You can read and review different types of software documentation, such as user guides, API references, tutorials, release notes, and technical specifications. Also consider joining online communities, forums, and blogs where software documentation experts share their insights, feedback, and resources. And attend webinars and workshops on software documentation topics.

2 Follow standards and guidelines

Follow the standards and guidelines that apply to your software domain, industry, and audience. For example, if you are documenting software for the web, follow the Web Content Accessibility Guidelines (WCAG) to ensure your documentation is accessible to people with disabilities. If you are documenting software for the medical field, follow the Health Level Seven (HL7) standards to ensure your documentation is interoperable and compliant. Also follow the style guides for your organization or client to ensure your documentation is consistent with their needs.

3 Use tools and technologies

Use the right tools and technologies to help you create, manage, and deliver your documentation. Use a documentation platform that allows you to write, edit, format, and publish your documentation in various formats and channels. And use tools that can help you automate, validate, and test your documentation, including spell checkers, grammar checkers, code editors, and documentation testing tools. Your tools should also help you collaborate with and get feedback from your team members, stakeholders, and users. Examples include version control systems, project management tools, and user feedback tools.

4 Update and improve your documentation

Review your documentation periodically and check for any errors or inconsistencies. Then update your documentation whenever there are changes in the software's functions or requirements. Also improve your documentation by applying the feedback you receive from team members, stakeholders, and users. Measure the effectiveness and usability of your documentation by using metrics, analytics, and user testing tools.

5 Learn new skills and knowledge

Keep up with the latest developments and innovations in the software industry and learn how they affect your documentation. Then learn new skills and knowledge that can help you write better documentation, such as technical writing, information architecture, user experience design, and content strategy. Also learn new skills to help you work better with team members, including communication, collaboration, and empathy.

6 Experiment and innovate

Don't be afraid to try new formats, styles, and techniques for your documentation. Challenge the status quo and propose new ideas and solutions for your documentation. Also don't be afraid to fail and learn from your mistakes. Always seek to improve your documentation and make it more useful, usable, and enjoyable for your audience.

7 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?