Technical Writer Software Documentation Specialist - 100% Remote
Posted 2 weeks ago by 1752562629
Negotiable
Outside
Remote
USA
Summary: We are looking for a Technical Writer with a strong software development background to create high-quality documentation for infrastructure-as-code and software tools. The role involves collaboration with developers and product managers to ensure clarity and accuracy in technical content. The ideal candidate will have experience with various documentation tools and environments, particularly in a remote setting. This position is contract-based and long-term.
Key Responsibilities:
- Create, edit, and maintain clear, concise, and accurate technical documentation, including:
- Developer guides
- User manuals
- API documentation
- Infrastructure setup (Terraform modules)
- Internal engineering wikis and SOPs
- Collaborate with engineering teams to gather technical information and translate complex concepts into easily understandable documentation.
- Write and format documents using Markdown and other lightweight markup languages.
- Maintain and version control documentation using GitLab repositories.
- Use Visual Studio Code (VS Code) and other developer tools to review code samples and understand implementation details.
- Document cross-platform workflows on both Windows and macOS environments.
- Contribute to the development and maintenance of internal knowledge bases and wikis.
- Ensure consistency, accuracy, and alignment of technical content across platforms.
- Assist in organizing and maintaining documentation portals or static site generators, such as Docusaurus, Hugo, or MkDocs (if applicable).
Key Skills:
- 3-7 years of professional experience as a Technical Writer in a software/technical environment.
- Proficiency with Markdown, Git, and version control best practices.
- Experience using GitLab for collaboration and CI/CD documentation.
- Familiarity with Terraform (HCL syntax) and infrastructure-as-code concepts.
- Proficient in Visual Studio Code (VS Code) for writing and code navigation.
- Experience working with or documenting for both Windows and macOS environments.
- Ability to read code (e.g., YAML, JSON, Bash, or basic Python) for the purpose of understanding technical workflows.
- Strong communication skills and ability to work independently with cross-functional teams.
- Attention to detail, organization, and a user-first approach to documentation.
Salary (Rate): undetermined
City: undetermined
Country: USA
Working Arrangements: remote
IR35 Status: outside IR35
Seniority Level: undetermined
Industry: IT
Job Title: Technical Writer Software Documentation Specialist
Location: Remote (USA)
Job Type: Contract
Duration: Long Term
Client Note:
- Looking for a technical writer who came from Software development background and not from QA.
- Required Skills: VS code, Gitlab, Terraform, Markdown, windows, and Mac
Job Summary:
We are seeking a highly skilled Technical Writer with a strong background in software development tools and environments to produce high-quality documentation that contributes to the overall success of our products. You will collaborate with developers, DevOps engineers, and product managers to create documentation for infrastructure-as-code (IaC), software tools, and internal processes.
Key Responsibilities:
- Create, edit, and maintain clear, concise, and accurate technical documentation, including:
- Developer guides
- User manuals
- API documentation
- Infrastructure setup (Terraform modules)
- Internal engineering wikis and SOPs
- Collaborate with engineering teams to gather technical information and translate complex concepts into easily understandable documentation.
- Write and format documents using Markdown and other lightweight markup languages.
- Maintain and version control documentation using GitLab repositories.
- Use Visual Studio Code (VS Code) and other developer tools to review code samples and understand implementation details.
- Document cross-platform workflows on both Windows and macOS environments.
- Contribute to the development and maintenance of internal knowledge bases and wikis.
- Ensure consistency, accuracy, and alignment of technical content across platforms.
- Assist in organizing and maintaining documentation portals or static site generators, such as Docusaurus, Hugo, or MkDocs (if applicable).
Required Skills and Experience:
- 3 7 years of professional experience as a Technical Writer in a software/technical environment.
- Proficiency with Markdown, Git, and version control best practices.
- Experience using GitLab for collaboration and CI/CD documentation.
- Familiarity with Terraform (HCL syntax) and infrastructure-as-code concepts.
- Proficient in Visual Studio Code (VS Code) for writing and code navigation.
- Experience working with or documenting for both Windows and macOS environments.
- Ability to read code (e.g., YAML, JSON, Bash, or basic Python) for the purpose of understanding technical workflows.
- Strong communication skills and ability to work independently with cross-functional teams.
- Attention to detail, organization, and a user-first approach to documentation.
Preferred Qualifications:
- Bachelor s degree in Computer Science, Technical Communication, Engineering, or related field.
- Experience with documentation automation tools or static site generators (e.g., MkDocs, Hugo).
- Exposure to Agile development environments and tools (JIRA, Confluence).
- Prior experience writing for DevOps, cloud infrastructure, or platform engineering teams.