Technical Writer
Job Summary:
The Technical Writer for Opsource will be responsible for creating clear, concise, and comprehensive documentation for the internal application. This role will work closely with product managers, engineers, and end-users to develop user manuals, API documentation, training materials, and best practice guides. The Technical Writer will ensure that all documentation is accessible, up-to-date, and structured to support the needs of internal teams using Opsource.
Supervisory Responsibilities:
- None
Required Education / Experience & Qualifications:
- Technical Writing Experience: Proven experience as a technical writer, preferably in enterprise software, SaaS, or internal application environments.
- Clear & Concise Writing Skills: Ability to explain complex technical concepts in simple, easy-to-understand language for various audiences.
- Documentation Tools: Experience with documentation tools such as Confluence, MadCap Flare, Markdown, or similar platforms.
- API & Software Documentation: Strong understanding of APIs, system architectures, and cloud-based applications, with the ability to document them effectively.
- Collaboration & Communication: Ability to work with engineers, product managers, and end-users to gather information and create high-quality documentation.
- Process & Workflow Documentation: Experience in developing SOPs, business process documentation, and user training materials.
Preferred Education / Experience & Qualifications:
- Azure & Cloud Applications: Familiarity with Azure-based applications, APIs, and cloud infrastructure documentation.
- Visual Documentation: Experience with tools like Visio, Lucidchart, or Figma for creating technical diagrams and workflows.
- Training & E-Learning: Background in developing training materials, online courses, or instructional content.
- AI & Automation: Knowledge of AI-driven tools and automation platforms to document workflow enhancements.
Duties & Responsibilities:
- User Documentation: Develop and maintain user guides, manuals, FAQs, and training materials to assist internal teams in using Opsource effectively.
- API & Developer Documentation: Write detailed technical documentation for APIs, integrations, and system configurations for developers and IT teams.
- Release Notes & Updates: Document new features, changes, and updates in release notes and communicate them clearly to stakeholders.
- Standard Operating Procedures (SOPs): Create process documentation and workflow guides to standardize the use of Opsource across departments.
- Collaboration with Product & Engineering Teams: Work closely with product managers and developers to understand new features and translate technical information into clear documentation.
- Content Organization & Accessibility: Structure and categorize documentation for easy access and usability, ensuring that internal teams can quickly find the information they need.
- Visual Aids & Diagrams: Create flowcharts, screenshots, and instructional graphics to enhance documentation and improve comprehension.
- Continuous Improvement: Regularly update documentation based on user feedback, application changes, and best practices in technical writing.
Physical Requirements:
- Prolonged periods sitting at a desk and working on a computer
- Must be able to lift up to 15 pounds at a time