Location: Rehmanabad, Rawalpindi
Job Type: Full time, onsite, 9am- 5pm
Department: IT
Job Overview:
We are seeking a Technical Documentation Specialist to create, maintain, and organize technical documentation for our software systems and applications. This role is crucial in ensuring seamless knowledge transfer, reducing onboarding time for new developers, and enhancing internal knowledge sharing.
Key Responsibilities:
1. Technical Proficiency
- Read and interpret code (preferably in relevant languages) to document software internals accurately.
- Collaborate with developers to extract and document essential technical details.
2. Document Structure & Standards
- Define standardized formats for documentation, including naming conventions, versioning, and update logs.
- Implement hierarchical structuring, tagging, and indexing for enhanced searchability and organization.
- Establish cross-referencing between architecture diagrams, API documentation, and code references for better navigation.
3. Collaboration & Maintenance
- Work closely with developers, product managers, and QA teams to ensure documentation remains current and relevant.
- Conduct periodic reviews and updates to align documentation with software development changes.
4. Integration with Development Workflow
- Automate documentation updates by integrating with version control platforms (GitHub, Bitbucket).
- Maintain detailed changelogs to track software updates and modifications.
Required Qualifications:
- Proven experience in technical writing within a software development environment.
- Proficiency in documentation tools such as Confluence, GitBook, Notion, or Read the Docs.
- Basic coding knowledge (e.g., Python, JavaScript, or other relevant languages).
- Strong ability to translate complex technical concepts into clear and structured documentation.
- Experience with diagramming tools like Lucidchart or draw.io for creating architecture and data flow diagrams.
Preferred Qualifications:
- Familiarity with CI/CD pipelines for documentation updates.
- Experience integrating documentation with API documentation tools like Swagger or Postman.