Services Details:
? Scope: Supporting software platforms (e,g.
MOMA as a product, and its developer environment search function)
? Deliverables: Software technical documentation, including API-level documentation.
? Requirements: Services resources must have a strong understanding of software development, platform APIs, and related terminolog
Role Overview:
A Technical Writer is responsible for creating clear, concise, and accurate documentation that helps users understand and utilize software products effectively.
In this role, you'll focus on supporting software platforms, such as MOMA and its developer environment search function.
Key Responsibilities:
? Create Comprehensive Documentation: Develop detailed technical documentation, including API-level documentation, that explains how to use the software efficiently.
? Ensure Accuracy: Verify the accuracy of technical information and ensure that documentation is up-to-date.
? Maintain Consistency: Maintain consistency in style, format, and terminology throughout all documentation.
? Collaborate with Developers: Work closely with software developers to understand product features and functionalities.
? Gather User Feedback: Collect feedback from users to improve documentation and address their needs.
Required Skills and Experience:
? Strong Technical Writing Skills: Proven ability to write clear, concise, and well-structured technical documentation.
? Software Development Understanding: A solid understanding of software development principles, methodologies, and terminology.
? API Documentation Expertise: Experience creating API-level documentation, including detailed descriptions of methods, parameters, and return values.
? Technical Knowledge: Familiarity with software development tools, platforms, and technologies
? Attention to Detail: Meticulous attention to detail to ensure accuracy and consistency in documentation.
? Excellent Communication Skills: Ability to communicate effectively with both technical and non-technical audiences.
? Problem-Solving Skills: The ability to identify and resolve documentation issues
Nível de experiência
Pleno-sênior
Setor
Atividades dos serviços de tecnologia da informação
Tipo de emprego
Tempo integral
Funções de trabalho
Tecnologia da informação
Competências
Redação
Documentação técnica
Redação técnica
Interface de programação de aplicativos (API)
Terminologia
Desenvolvimento de software
Resolução de problemas
Comunicação
Manuais
Ajuda