Technical Writer

Key Responsibilities

• API & Developer Documentation: Write, update, and maintain comprehensive REST/gRPC API documentation, SDK guides, and code samples for .NET applications using OpenAPI/Swagger.
• Technical Writing & Architecture Guides: Produce detailed technical specifications, system architecture diagrams, deployment guides, and release notes for both internal engineering teams and external developers.
• Code Understanding: Read and analyze C# source code and .NET solution structures to accurately document methods, classes, dependencies, and configuration setups.
• Documentation Maintenance: Collaborate with engineering teams during sprint cycles to ensure technical docs remain up to date with new features, breaking changes, and code refactoring.
• Standards & Style: Establish and enforce consistent documentation standards, style guides, and terminology across product engineering.

Qualifications

• Technical Background: Bachelor’s degree in Computer Science, Software Engineering, Technical Communication, or equivalent practical experience.
• .NET Expertise: 2+ years of experience working with C#, .NET/.NET Core frameworks, ASP.NET Core, and common .NET libraries/tools.
• Technical Writing Experience: 3+ years of technical writing experience focusing on developer-facing documentation, API references, and software architecture.
• Tooling Proficiency: Hands-on experience with Docs-as-Code workflows (Git, Markdown, Static Site Generators like DocFX, Docusaurus, or Hugo).
• API Documentation: Proficiency with tools like Postman, Swagger/OpenAPI, and API testing workflows.
• Communication: Exceptional written and verbal communication skills in English, with a strong ability to explain complex technical concepts clearly.

Preferred Qualifications

• Prior experience working as a Software Developer or QA Engineer in a .NET environment.
• Familiarity with CI/CD pipelines (GitHub Actions, Azure DevOps) for automated documentation deployment.
• Understanding of cloud services (Azure/AWS) and containerization (Docker).