What do I do as a Technical Writer?
In short, my role as a technical writer is to communicate technical information to various audiences.
As a tech writer I use a variety of tools in my day-to-day work to convey information to the end user in an applicable and comprehensible way. These tools include version control systems, XML’s, and text processing programs, such as GitHub, DITA XML, and Microsoft Word.
My experience with technical communication consists of writing, editing, and translating technical SEO web content, software and hardware documentation, user manuals, grant proposals, and other types of information. My areas of expertise as a tech writer are software, science, hardware, and medicine.
Among the services that I offer are technical writing and editing, user experience design, and data analysis. I provide companies and organizations with, among other things:
> User manuals
> Product descriptions
> Installation guides
> Fact sheets
> Category texts
> Technical SEO web content
> Grant proposals
> Software documentation
> UX Writing
To deliver optimal results I may conduct interviews with developers, product owners, designers, and other stakeholders.
My strength as a technical writer is a comprehensive technical knowledge combined with strong writing skills. After years in the educational sector, I have learned to communicate highly specialized knowledge in a comprehensible and pedagogic manner. This enables me to serve as link between experts and developers on the one hand and end users and audiences on the other hand.
My Approach to Technical Writing⌗
Docs like Code. Structured Writing. ASD-STE100 Simplified Technical English. These are all terms that float around the field of technical writing. Each of these terms cover different methods applied and practiced by tech writers. Each method has its merits and strengths depending on the subject matter of the content, the end user, the scope of the content, and the values and guidelines of the company or organization behind the text.
As a tech writer I am flexible regarding the methods based on the nature of the task at hand. Regardless of the methods, my approach to technical writing is based on four pragmatic rules:
1. Keep the end user in mind – a tech writer should be the reader’s advocate
2. Stay true to the values, mission, and internal guidelines of the sender
3. Keep it clear – explain one aspect at the time in a clear language
4. Technical texts can still be enjoyable - even though the topics are complex
In short, I always strive to deliver well written, great technical content that focuses on the needs of the end user without loosing sight of the goals of the sender organization.
Tools and technologies⌗
A tech writer applies various tools when producing documentation and other types of text. I have experience with the following technologies and programming languages:
> Git and GitHub
> DITA XML
> Memsource (and other CAT Tools)
> Microsoft Word
> Microsoft Access
> Markdown
> VS Code
> Hugo
> JavaScript
> Python (Including PyCharm and Anaconda)