About the job Senior Technical Writer (ERP Products)
Senior Technical Writer (ERP Products)
Location: Colombo, Sri Lanka or Muscat, Oman
About the Role
We are seeking an experienced Senior Technical Writer to create, manage, and maintain high-quality documentation for our ERP software products. This role is essential for ensuring that users, partners, and implementers can efficiently understand, configure, and deploy our ERP system.
You will work closely with Product Management, Engineering, and QA teams in an Agile development environment to produce comprehensive user guides, functional and technical documentation, and API references. You will also be responsible for maintaining a structured documentation repository, release notes, and training materials.
If you have a strong technical writing background, deep knowledge of ERP products, and a passion for making complex systems easy to understand, we'd look forward to hear from you!
Key Responsibilities
1. Documentation Development & Maintenance
- Create and maintain user manuals, functional guide, technical documentation, configuration guides, and implementation manuals for ERP products.
- Develop and update release notes for each product version, ensuring users are aware of new features, enhancements, and bug fixes.
- Produce API documentation for developers and integrators, explaining data models, endpoints, and workflows.
- Ensure content is structured, searchable, and aligned with industry best practices for ERP documentation.
2. Collaboration with Cross-Functional Teams
- Work in an Agile environment, collaborating with Product, Engineering, QA and Release teams to gather information and ensure documentation accuracy.
- Participate in sprint reviews, product demos, and requirement discussions to stay informed about upcoming changes.
- Gather feedback from users, partners, and implementation teams to continuously refine documentation.
3. Documentation Repository & Version Control
- Maintain a centralized documentation repository accessible to internal and external stakeholders.
- Use version control systems (Git, GitHub, or similar) to manage documentation updates alongside software releases.
- Ensure documentation for each release is properly categorized and maintained for historical reference.
4. ERP-Specific Focus Areas
- Document ERP modules such as Finance, Supply Chain, Procurement, HR, CRM, Manufacturing, and Inventory Management.
- Provide detailed process flows, configuration steps, best practices, and troubleshooting guides.
- Develop documentation to support ERP customization, integrations, and implementation methodologies.
- Work with SMEs (subject matter experts) to create training materials and knowledge base articles for ERP consultants and implementers.
5. Content Strategy & Documentation Standards
- Define and enforce style guides, templates, and best practices to ensure consistency.
- Optimize documentation for readability, navigation, and SEO within the knowledge base.
- Explore interactive documentation formats (e.g., API playgrounds, markdown-based static sites).
6. Multimedia & Training Content
- Develop diagrams, flowcharts, and process maps to illustrate ERP system workflows.
- Create video-based tutorials and walkthroughs for ERP users and administrators.
Qualifications & Skills
1. Experience & Background
- 6+ years of experience in technical writing for ERP software products.
- Strong understanding of ERP system architecture, workflows, configurations, and implementation.
- Experience working in an Agile team alongside Product, Engineering, and QA teams.
2. Technical & Writing Skills
- Exceptional written communication skills, with the ability to simplify complex ERP concepts.
- Expertise in writing user guides, manuals, API documentation, release notes, and training materials.
- Strong understanding of data models, workflows, system configurations, and business processes within an ERP system.
- Familiarity with ERP integration, APIs, and SDK documentation.
- Knowledge of structured writing approaches (DITA, Markdown, reStructuredText, or AsciiDoc).
3. Tools & Technologies
- Documentation Tools: Confluence, MadCap Flare, Paligo, Adobe FrameMaker, Notion.
- ERP Documentation Platforms: ERPNext Docs, SAP Enable Now, Oracle UPK, or similar tools.
- API Documentation: Swagger (OpenAPI), Postman, Redocly.
- Version Control: Git, GitHub/GitLab for documentation tracking.
- Diagram & Multimedia Tools: Visio, Draw.io, Snagit, Camtasia, or similar tools.
4. Soft Skills
- Strong collaboration skills to work with Product Managers, Engineers, QA and Release teams.
- Ability to work independently and manage multiple documentation projects simultaneously.
- Attention to detail and a passion for clarity in writing.
Preferred Qualifications
- Experience with static site generators (Docusaurus, MkDocs, Jekyll, Hugo).
- Familiarity with ERP implementation methodologies.
- Previous experience in documenting multi-tenant SaaS ERP platforms.