16 Aug
|
Nameless
|
Whitefield
16 Aug
Nameless
Whitefield
Technical Documentation Specialist (Individual Contributor) Discrete Manufacturing
Role Summary
The Technical Documentation Specialist is an individual contributor responsible for creating, maintaining, and improving customerâfacing and internal documentation for CAI’s discrete manufacturing software products. The role focuses on highâquality product documentation and knowledge base content, while also generating short, reusable content pieces that can be distributed across support, inâapp experiences, and customer communications.
Key Responsibilities
Product & User Documentation
-
Plan, write, and maintain userâfacing documentation, including user guides, online help, FAQs, troubleshooting topics, and release notes.
-
Document product features, workflows, and configurations in clear, taskâbased formats that help users complete real jobs.
-
Maintain integration and technical reference content where needed, in collaboration with engineering and product.
Knowledge Base & MicroâContent
-
Build and maintain the product knowledge base, ensuring content is accurate, searchable, and easy to navigate.
-
Break down longâform documentation into short, reusable content pieces (e.g., howâto snippets, support macros, inâapp tips, quickâstart cards).
-
Create lightweight multimedia where appropriate (annotated screenshots, GIFs, or short screenâcapture videos) to clarify complex workflows.
-
Partner with Support and Product to identify highâvalue questions and turn them into concise, shareable answers.
Content Standards & Governance
-
Apply and continuously improve documentation standards, style guides, templates, and voice/tone guidelines.
-
Ensure consistency, version control, and quality across all documentation and content types.
-
Help define and refine information architecture, tagging,
and linking to improve content discoverability and selfâservice.
Collaboration & Delivery
-
Work closely with Product Management, Engineering, UX, Support, and Services to gather information, validate behavior, and plan documentation work.
-
Participate in release and project planning to align documentation and microâcontent with product delivery timelines.
-
Use product builds directly to explore features, test workflows, and proactively identify documentation needs.
Measurement & Continuous Improvement
-
Monitor documentation and knowledge base analytics (views, search terms, gaps, and related support tickets) to prioritize improvements.
-
Iterate on content based on feedback from customers, internal teams, and observed usage patterns.
Required Skills & Experience
-
4+ years of experience as a technical writer or similar role in a software or SaaS setting.
-
Demonstrated experience owning endâtoâend product documentation and knowledge base content.
-
Excellent English writing and editing skills; able to communicate complex technical concepts clearly for both technical and nonâtechnical audiences.
-
Strong organizational skills and the ability to manage multiple documentation projects in an agile, fastâpaced environment.
-
Comfortable working directly with product builds and interviewing subjectâmatter experts to gather information and edge cases.
-
Experience creating shortâform content (snippets, help articles, support macros, or short videos) from core documentation.
Tools & Technical Proficiency
-
Proficiency with documentation and knowledge tools (e.g., Confluence or Notion, helpâcenter/KB platforms, MS Word/PowerPoint).
-
Familiarity with issue tracking and product tools (e.g., Jira, Aha! or similar).
-
Experience with version control and/or docsâasâcode workflows (e.g., Git, Markdown, or structured authoring) is a plus.
-
Basic familiarity with software concepts such as APIs, integrations, and data flows.
-
Experience with Snagit, diagramming, and basic video/screenâcapture tools is a plus.
Qualifications
-
Bachelor’s degree in Technical Writing, English, Communications, Computer Science, or a related field; or equivalent practical experience.
-
Technical writing or documentation certifications are a plus.
-
Experience in B2B, ERP, or discrete manufacturing software environments is strongly preferred.
JD in simple terms (what the role actually does)
This role owns endâtoâend product documentation for CAI’s discrete manufacturing software. That includes:
-
Writing and maintaining user guides, online help, FAQs, release notes, troubleshooting.
-
Turning long guides into short, reusable microâcontent (howâto snippets, support macros, inâapp tips, quick-start cards).
-
Maintaining a Knowledge Base that’s accurate, searchable, and wellâstructured.
-
Adding lightweight visuals (annotated screenshots, GIFs, short screenâcapture videos) to clarify workflows.
-
Collaborating closely with Product, Engineering, UX, Support, Services; using product builds to verify features.
-
Tracking content analytics (views, search terms, gaps, tickets) and iterating.
Target environment: B2B SaaS with a strong preference for ERP / discrete manufacturing exposure.
📌 Technical Writer (Whitefield)
🏢 Nameless
📍 Whitefield