How I work
How I work
Typically, I analyse and evaluate your current documentation status, I do a documentation audit, interview stakeholders and end-users, investigate information seeking behaviour and create a solution that fits your specific needs. Then I devise a plan to get you from your current position to a desired position agreed with you.
This can include:
- Creating docs standards including the use of a style guide,
- Embedding a style guide and best practices into templates and the documentation workflow
- Recommending and implementing a new documentation tool,
- Building a new docs system,
- Devising comprehensive writing training,
- Reviewing and restructuring existing documentation
- Rewriting or creating documentation that is concise, clear and empathic to the needs of your intended audience.
- Implementing ways to collect metrics to gauge success.
Who is your audience?
Purposeful content is vital to ensure that documentation is meeting the needs and goals of the consumers of content.
Are they engineers or decision makers? Are they engineers new to this space e.g. web3 or coming from Ethereum? Knowing the audience personas is vital to inform the creation of documentation that is pitched at the right level. There is often a gap between the language used by creators of technology and the end users who need to engage with it. This 'curse of knowledge' can be an obstacle to enabling adoption and user competence. It's always worth spending time understanding who your audience is and what their goals are.
User personas and research allows for the creation of typical user journeys and content tailored to fit. The success of content can then be tracked alongside user goals. It can be more easily measured and monitored through analytics as well as on page surveys.
I act as an advocate for the end user to try and ensure frictionless comprehension and successful adoption.
Ideally, thought should go into understanding how to create docs that the intended audience want to consume. Thinking about the visual design and type of content or media as well as the language and terminology used.
This gap between technology, business objectives and users is one that I inhabit.
Expertly tailored by design
Fusing skills in information technology, development and user experience, I am uniquely placed to meet your documentation needs.