Technical Writer  

1. Documentation Development & Management
   1. Technical Documentation Creation

1.1.1. Develop comprehensive technical documentation for enterprise systems, APIs, and software applications;

1.1.2. Create and maintain user manuals, system guides, and standard operating procedures;

1.1.3. Document system architectures, integration flows, and technical specifications;

1.1.4. Ensure documentation alignment with both Agile and traditional development methodologies; and

1.1.5. Implement version control and documentation lifecycle management practices.

1. 1. Content Strategy & Standards

1.2.1. Develop and maintain documentation templates and style guides;

1.2.2. Implement documentation best practices and industry standards;

1.2.3. Create and maintain information architecture for technical content;

1.2.4. Ensure consistency across all technical documentation; and,

1.2.5. Optimize content for searchability and user experience.

1. Technical Collaboration & Integration
   1. Engineering Team Collaboration

2.1.1. Work with development teams to gather technical requirements;

2.1.2. Participate in sprint planning and technical review sessions;

2.1.3. Review code repositories and technical specifications;

2.1.4. Validate technical accuracy of documentation; and,

2.1.5. Maintain alignment with product development cycles.

1. 1. Quality Assurance and Improvement

2.2.1. Perform regular documentation audits and quality checks;

2.2.2. Track and implement user feedback on documentation;

2.2.3. Monitor documentation effectiveness through metrics;

2.2.4. Maintain compliance with security and regulatory requirements; and,

2.2.5. Drive continuous improvement in documentation processes.

1. Technical Knowledge Management
   1. Knowledge Base Development

3.1.1. Create and maintain technical knowledge base articles;

3.1.2. Develop troubleshooting guides and FAQs;

3.1.3. Document best practices and common solutions;

3.1.4. Organize technical content for easy access; and,

3.1.5. Update documentation based on system changes and updates.

1. 1. Technical Communication

3.2.1. Transform complex technical concepts into clear documentation;

3.2.2. Create visual aids and diagrams for technical concepts;

3.2.3. Develop training materials for technical features;

3.2.4. Write release notes and technical bulletins; and,

3.2.5. Maintain consistent technical terminology.

1. Minimum 3+ years of technical writing experience in software/IT industry;
2. Strong understanding with enterprise software and API documentation, preferably with portfolio of technical documentation samples;
3. Knowledge of static site generators (Jekyll, Hugo);
4. Familiarity with basic programming concepts and languages (JavaScript, Python), database systems, cloud platforms, API documentation, and system architecture; and,
5. Proficiency in tools for documentation platforms such as Confluence and SharePoint, markdown and technical writing tools, diagramming tools such as Visio, Drawio, and version control systems such as Git.