Technical Writer

Job Summary: 

CircleCI is looking for a detail-oriented and experienced Technical
Writer to join our team. As a Technical Writer at CircleCI, you will play a critical role in
creating clear, concise, and engaging technical content that helps users understand and
leverage our platform effectively. You will collaborate with cross-functional teams to
produce documentation, guides, tutorials, and other written materials that empower our
customers and enhance their experience with CircleCI.

Responsibilities:

1. Documentation Creation:

• Develop comprehensive and user-friendly technical documentation for
  CircleCI products, features, and APIs to support users at various skill
  levels.
• Write clear and concise guides, tutorials, and release notes that help
  users set up, configure, and troubleshoot issues on the platform.

2. Content Management:

• Organize, categorize, and maintain the documentation library, ensuring
  content is up-to-date, accurate, and accessible to users.
• Collaborate with product managers, engineers, and support teams to
  gather information and ensure documentation aligns with product updates
  and releases.

3. User Experience Improvement:

• Conduct usability testing, gather feedback, and incorporate user insights
  to enhance the readability and effectiveness of documentation.
• Continuously improve documentation processes, content structure, and
  information architecture to optimize user experience.

4. API Documentation:

• Create and maintain API documentation that helps developers integrate
  with CircleCI, understand authentication methods, and leverage platform
  capabilities efficiently.
• Provide examples, code snippets, and use cases to guide developers in
  using CircleCI APIs effectively.

5. Training Materials:

• Develop training materials, user guides, and onboarding resources to
  educate users, customers, and internal teams on best practices for
  utilizing CircleCI tools and features.
• Conduct training sessions, webinars, and knowledge-sharing workshops
  to promote effective documentation usage and adoption.

6. Quality Assurance:

• Ensure accuracy, consistency, and alignment with brand guidelines in all
  technical documentation produced.
• Conduct regular reviews, updates, and edits to maintain high-quality
  content standards and address feedback from users and stakeholders.

Requirements:

• Bachelor’s degree in Technical Writing, English, Computer Science, or a related
  field.
• 3+ years of experience as a technical writer, creating documentation for software
  products, APIs, or developer tools.
• Proficiency in tools like Markdown, DITA, Confluence, or similar platforms for
  document creation and management.
• Strong technical aptitude and the ability to understand complex technical
  concepts and translate them into clear, user-friendly documentation.
• Excellent writing, editing, proofreading, and communication skills with attention to
  detail.
• Experience working in an agile development environment and collaborating with
  cross-functional teams.
• Knowledge of version control systems (Git), content management best practices,
  and documentation tools.

**Join CircleCI as a Technical Writer and contribute to delivering high-quality technical
content that empowers users, enhances product adoption, and improves the overall
user experience. Apply now to showcase your expertise in technical writing,
documentation creation, and user education within a fast-paced environment.

Last updated on Aug 23, 2024