Responsible for creating and updating technical documentation for precision systems with a focus on English manuals. Engaging with specialists and overseeing editorial standards.
About the role
- Technical Writer collaborating with R&D team to produce documentation for Critical Manufacturing's MES software. Involves creating content for users and developers including guides and tutorials.
Responsibilities
- Write, test and document product features according to Critical Manufacturing’s user and developer documentation best practices and guidelines, to translate complex information into clear and effective content
- Work closely with developers and technical experts to obtain an in-depth understanding of the product and ensure the accuracy of the documentation
- Develop extensibility documentation to help third-party developers build on top of our platform
- Act as a customer advocate, ensuring the documentation meets the needs of the user and is highly available to them
- Manage updates and revisions of the documentation
- Contribute to establishing best practices and standards for technical documentation within the organization
- Leverage AI-assisted tools to improve documentation workflows, including proofreading, content enhancement, summarization, snippet generation, consistency checks, and experimentation with new AI-based documentation practices
Requirements
- Ability to translate complex engineering procedures into simple and clear instructions
- Ability to read and understand code (e.g., JavaScript, Python, C#, or similar)
- Ability to write in explanatory and procedural styles for multiple audiences and personas
- Familiarity with tools for writing and publishing technical documentation (e.g., Markdown, Confluence, MkDocs, Docusaurus, or similar) and API specification (Swagger/OpenAPI/docfx or similar)
- An automation mindset to retrieve, review and publish information from multiple sources
- Excellent English skills – spoken and written
- Strong attention to detail and creative thinking skills
- Basic knowledge of modern AI tools (e.g., ChatGPT, Copilot, or similar) and willingness to experiment with them to improve documentation quality and productivity
- What we consider a plus (not mandatory):
- Background in software development, programming, or working closely with developers
- Experience documenting extensible systems or platforms, API documentation with conceptual guides
- Experience in dealing with software development teams
- Technical expertise in navigating large codebases
- Experience working in an Agile software development environment
- Familiarity with CI/CD and modern DevOps practices
- Understanding of version control systems like Git
- Experience creating automation scripts in Python or other scripting languages
- Experience designing or improving documentation workflows using AI-powered tools
Job title
Job type
Experience level
Salary
Not specified
Degree requirement
Tech skills
Location requirements
Technical Writer creating interactive web products for LawDepot, enhancing usability and engagement for legal documents. Collaborate with cross - functional teams to improve customer experience.
Technical Editor at LawDepot enhancing interactive web products for legal document creation. Collaborate with UX Optimization team to ensure user - friendly and engaging templates.
Technical Content Writer creating tech - related content to educate clients and improve product awareness at SiteGround. Requires excellent English command and 3+ years of experience in technical writing.
Technical Writer II supporting U.S. Coast Guard Command and Control systems. Managing documentation and technical writing for engineering and technical projects.
Technical Writer for Leidos supporting critical Air Force systems development. Writing, editing, and proofreading technical documents with a collaborative engineering team.
Technical Writer responsible for creating technical product documentation at Semperis, a cybersecurity company. Collaborates with developers and SMEs to explain complex software solutions.
Technical Writer documenting complex software solutions at Semperis. Responsible for writing, reviewing, and maintaining technical product documentation.
Senior Technical Writer at Semperis creating documentation for software solutions. Collaborating with engineers to ensure accuracy in technical writing within a hybrid work environment.
Technical Writer responsible for creating technical documentation in a cybersecurity company. Collaborating with developers and SMEs to ensure content accuracy and usability.