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
Senior Technical Writer at TaskUs creating documentation and processes for exceptional customer experiences. Collaborating with teams to enhance internal documentation for disruptive companies.
Technical Writer & Trainer responsible for technical documentation and staff training at Helcim. Empowering users with clear guidance on Helcim's payment platform through comprehensive documentation and training initiatives.
Senior Technical Writer creating user - centric documentation for investment management solutions at SimCorp. Collaborating with agile teams to improve user assistance and documentation quality.
Technical Writer I responsible for revising and authoring technical documentation for Centurum's products and services. Requires a Secret US DoD security clearance and travel of 15%.
Senior Technical Writer producing interactive documentation for military systems. Supervise content development and produce documentation using XML and other web languages.
Technical Writer responsible for producing technical documentation and managing SOPs at L3Harris. Collaborating with engineering teams to ensure quality and accuracy in product documentation.
Senior Technical Writer at Apex Fintech Solutions developing API documentation for financial infrastructure products. Collaborating across teams to ensure accuracy and clarity of technical content.
Technical Documentation Writer at Hitachi Energy translating complex technical knowledge into clear engineering narratives for various audiences. Collaborating with experts and ensuring compliance with industry standards.
Technical Writer and Document Manager for iT1 managing organizational document lifecycles. Responsible for compliance, document workflows, and collaborating with cross - functional teams.
Technical Writer role at Virginia Department of Elections focuses on clear communication of technical documents. Ideal for candidates experienced in Agile environments and technical writing.