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
Technical Writer creating clear documentation for legal technology. Collaborating with cross - functional teams to ensure product understanding and alignment with business goals.
Intermediate Technical Writer preparing and revising technical documents for Thales' Integrated Logistics Support team. Involves collaboration on technical data packages and detailed documentation revisions.
Senior Technical Content Architect responsible for customer - facing documentation for BlackBerry Secusmart products. Leading the documentation strategy and ensuring compliance with regulatory standards.
Senior Technical Writer at Flexera documenting cloud products and collaborating with engineering teams on technical documentation standards. Covering new product features and ensuring technical accuracy.
Technical Writer 3 preparing, reviewing, and maintaining technical documentation for government systems engineering projects. Involves collaboration with developers and technical personnel at Fort Meade, Maryland.
Technical Writer responsible for end - to - end product documentation at Foxglove. Collaborating with engineering and product teams to create and maintain user - facing technical content.
Senior Technical Writer at Relay, focusing on improving user experience through clear in - product communication in a fintech environment. Collaborating across teams to refine voice and messaging.
Senior Technical Writer at Relay crafting user - facing communication for a digital banking platform. Collaborate cross - functionally to improve onboarding and product clarity in user experiences.
Technical Writer creating and reviewing technical documentation for GDIT's IT products. Ensuring clarity and compliance with agency standards while collaborating on a variety of projects.