Sid Global Solutions (Digital Transformation Experts) - Exton, PA

posted 4 months ago

Full-time
Exton, PA
Professional, Scientific, and Technical Services

About the position

We are seeking a talented and detail-oriented Technical Writer to join our team. The ideal candidate will be responsible for creating clear, concise, and comprehensive documentation that accurately conveys technical information to a diverse audience. The Technical Writer will collaborate closely with product managers, engineers, and other stakeholders to ensure documentation is accurate, complete, and easy to understand. This role requires a strong understanding of technical concepts and the ability to communicate them effectively to various audiences, including developers, end-users, and non-technical stakeholders. The Technical Writer will also be responsible for staying updated with the latest industry trends and best practices in technical writing, ensuring that our documentation processes are continuously improved. In this position, you will develop, write, and edit technical content, including user manuals, installation guides, API documentation, technical specifications, and other instructional materials. You will organize and manage the repository of technical documents, ensuring they are up-to-date and easily accessible. Collaboration with subject matter experts (SMEs) is crucial, as you will gather information, review content, and validate technical details. Quality assurance is also a key aspect of this role, as you will review and edit documentation for accuracy, clarity, and consistency, ensuring it meets the company's standards and guidelines. Additionally, you will identify and understand the needs of different target audiences, adapting your writing style and content accordingly.

Responsibilities

  • Develop, write, and edit technical content, including user manuals, installation guides, API documentation, and technical specifications.
  • Organize and manage the repository of technical documents, ensuring they are up-to-date and easily accessible.
  • Work closely with subject matter experts (SMEs) to gather information, review content, and validate technical details.
  • Review and edit documentation for accuracy, clarity, and consistency, ensuring it meets the company's standards and guidelines.
  • Identify and understand the needs of different target audiences, including developers, end-users, and non-technical stakeholders.
  • Stay updated with the latest industry trends and best practices in technical writing and incorporate them into documentation processes.
  • Utilize documentation tools and software (e.g., Markdown, DITA, Confluence, Adobe FrameMaker) to create and manage content.

Requirements

  • Bachelor's degree in Technical Communication, English, Computer Science, or a related field.
  • At least 5+ years proven experience as a Technical Writer, with a strong portfolio of work demonstrating technical writing skills.
  • Proficiency in using documentation tools and familiarity with software development processes and tools (e.g., Git, JIRA).
  • Excellent writing, editing, and proofreading skills with the ability to explain complex technical concepts in simple terms.
  • Strong interpersonal skills and the ability to work effectively with cross-functional teams.
  • Keen attention to detail, with strong organizational and time management skills.
  • Ability to quickly grasp new technical concepts and adapt to changing requirements.

Nice-to-haves

  • Experience with content management systems (CMS) and version control systems.
  • Knowledge of API documentation and developer-focused writing.
  • Familiarity with graphic design tools for creating visual aids and diagrams.
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service