Job Description:
We are seeking a skilled and detail-oriented Technical Writer to join our team. As a Technical Writer specializing in protocol documentation, you will play a crucial role in creating accurate and comprehensive documentation for our software products. Your responsibilities will include researching, writing, and maintaining technical content related to protocols, APIs, and network communication. You'll collaborate with cross-functional teams, including developers and engineers, to ensure that our documentation meets high standards of clarity, accuracy, and usability.
Responsibilities:
Protocol Documentation:
● Identify new or updated protocols through the inventory process.● Create work items in Azure DevOps (ADO) for each protocol.● Research and understand the content to be documented.● Author the document according to agreed-upon milestones.● Deliver the final document to the Content Team Primary Writer (PW).
Triage & Resolve Technical Documentation Issues (TDIs):
● Resolve TDIs in Azure Dev Ops (ADO) for assigned documents.● Test and verify protocol behavior on Windows Servers/Clients.● Provide proposed workarounds to Protocol Support Engineers.● Deliver fixes for affected documents.
Test Code Creation:
● Develop test code based on TDI requirements and new content.● Test protocol behavior using tools like Network Monitor or Wireshark.
Document Updates:
● Incorporate TDIs into existing protocol documentation.● Reflect changes to product source code in the documentation.● Ensure compliance with document templates provided by Customer/Client.
Review and Quality Assurance:
● Review updated protocol documentation for consistency, clarity, and correctness.● Verify terminology and style usage according to Customer/Client guidelines.● Correct spelling, grammar, and punctuation errors.
Authoring Tools:
● Use provided authoring tools to create, edit, and maintain documents.
