L
Technical Writer
L
- Posted a month ago
- Over 100 applicants have applied
Job Description
- Key Responsibilities:
- Documentation Creation:
- Write, edit, and maintain user manuals, online help guides, technical documentation, and FAQs for a range of audiences, including developers, administrators, and end-users.
- Create API documentation, including detailed explanations of endpoints, request/response formats, and usage examples.
- Develop installation guides, configuration manuals, and release notes that are clear, comprehensive, and easy to understand.
- Collaboration & Research:
- Work closely with engineering teams, product managers, and subject matter experts (SMEs) to gather and clarify technical information.
- Conduct interviews, attend meetings, and review product specifications to understand new features and complex workflows.
- Ensure that all documentation accurately reflects the functionality of the product and is aligned with user requirements.
- Content Structuring & Standards:
- Organize content in a logical, easy-to-follow manner that enhances user experience and minimizes confusion.
- Develop and maintain documentation standards and templates to ensure consistency across all materials.
- Ensure that all documentation adheres to the company's tone, style, and formatting guidelines.
- Content Management:
- Update documentation regularly to keep it aligned with new releases, bug fixes, and product changes.
- Maintain version control of documentation and ensure that outdated materials are archived or removed.
- Organize documentation in repositories (e.g., GitHub, Confluence, or SharePoint) for easy access and collaboration.
- User Feedback & Continuous Improvement:
- Collect feedback from users and internal stakeholders to improve the clarity and usefulness of the documentation.
- Conduct usability tests with end-users to validate the effectiveness of guides and instructions.
- Monitor industry trends and tools to continuously improve the quality and delivery of technical content.
- Documentation for Internal Teams:
- Create internal documentation such as technical specifications, troubleshooting guides, and workflow documentation to support internal processes and teams.
- Assist in creating knowledge base articles for support teams to aid in customer troubleshooting and issue resolution.
- Tool & Technology Management:
- Use and manage documentation tools such as MadCap Flare, Adobe FrameMaker, Microsoft Word, Confluence, Markdown, or others for creating and publishing content.
- Stay up-to-date with new authoring tools, documentation processes, and technologies to increase productivity and the quality of outputs.
- Editing & Quality Assurance:
- Proofread and edit documents for grammar, clarity, consistency, and accuracy.
- Ensure that technical terms and jargon are used appropriately, and that content is understandable by the intended audience.
More Info
Key Skills
About Company
Laminaar Aviation Infotech is a global applications software solutions and consulting services provider to the aviation industry. Its proprietary software suite, ARMS®, is a comprehensive solution that is tailor-made to suit the operations for airlines, business aviation, airports, ANSP and defense.
Skills:
markdown , Technical Documentation, Apis, Incident Management, Json, Devops, Git, REST, Cloud Infrastructure, Kubernetes, LLMs, CLI tools, Technical Writing, AI-assisted content creation, AI developer tools, Developer tooling, Observability
Skills:
markdown , Github, Release Notes, Git, Confluence, Jira, Visual Studio Code, Developer documentation, Developer tools documentation, Acrolinx
Skills:
Engineering documentation lifecycle, Plant Operations, Understanding of refinery and petrochemical process units, Technical Writing, Documentation quality assurance, Editing, Safety, Maintenance, Content structuring
Skills:
Confluence, Agile Methodology, Jira, DevOps practices, api documentation
Skills:
content management systems (CMS), Agile Development Methodologies, version control software, Snagit editor, Tridion Docs, Visio, DITA XML, Oxygen XML