Software documentation, user guides, and technical manuals

Starting at

$

30

/hr

About this service

Summary

I would be glad to help you publish comprehensive and accurate user documentation for your software product.
My services include:
- Reviewing product changes as compared to already published documentation
- Writing/rewriting documentation to match the latest/planned release
- Adding screenshots, short videos to the instruction material
- Collaborating with developers, testers, and other SMEs to ensure documentation accuracy
- (optional) Publishing documentation to your content management system

Process

First off, I will need to understand the scope of your documentation needs. So, it makes sense to jump on a call to discuss the basics of your software product.
After the introduction call, you can share screenshots of your software products for the sections you want documented. Alternatively, you can provide a test environment so I can play around with the application and get familiar with the features. Here you can also share important contacts for SMEs who Ican contact if I need clarification on anything. These can be product managers or QA engineers- depending on your organizational structure. Next, I will write the first draft and send it to SMEs to check correctnes of the information. Required revisions are handled in this third step.
Once SMEs are satisfied with the draft, I will publish to your CMS or submit to the relevant person.

What's included

  • Knowledge base | help center content

    Clear and concise user documentation for your software product either in google docs format or published to your CMS. I can follow your existing tone and style guidelines to ensure consistency across your website. I will add screenshots from your product where necessary.


Skills and tools

Content Writer

Technical Writer

Canva

Google Docs

Microsoft Word

Zendesk

Industries

SaaS
Software