Technical writing: Methodologies
Mytra Control
About the project
Product
Methodologies to set the company way of working in certain areas, for example:
UX/UI
Software Requirements Specification (SRS)
Audience
Company employees.
Collaborators
These documents were developed in collaboration with in-company subject-matter experts, or Heads of unit.
Problems and goals
Concept and Writing
The growth of the company makes it necessary to establish common frameworks for the development of projects according to specific strategic lines.
So, it is necessary to ensure that the company have a set of methodologies that establish a contextual framework and modus operandi that must be followed to develop certain works according to a coherent and logical scheme.
Solutions
How do I approach the project?
1. Define the workflow that must be followed to create new methodologies.
2. In collaboration with coordinators and teams, be aware of their workflows to detect new needs to standardize the working processes through new methodologies.
3. Identification and definition with SMEs or Heads of unit the key points and requirements that new methodologies must fulfil.
4. Research on the state of the art about the subject (competitors, standards, models…).
5. Analyse and evaluate the resources collected to extract key information that match the key points and requirements defined.
6. Define the information architecture of the new methodology.
7. Write down and edit methodology text.
8. Define and prepare suitable illustrations to accompany text.
9. Check with SMEs or Heads of unit the fulfilment of the requirements and needs defined.
10. Publish the new methodology on the appropriate channels.
