Position Technical Writer

Location Dallas ,TX

Duration 6 months

Key Skills:

• Technical writing
• Content creation and organization
• Research and collaboration
• Document planning and scheduling
• Visual aid creation
• Editing and proofreading
• User guides and training materials
• Compliance and standards adherence
• Knowledge sharing

Mandatory Skills:

• Bachelor's degree in technical writing, computer science, engineering, or a related field (or equivalent experience).
• Proven experience as a technical writer, ideally in a platform engineering or infrastructure environment.
• Proficiency in technical writing tools and documentation platforms (e.g., Markdown, Confluence, LaTeX).
• Familiarity with version control systems (e.g., Git) and documentation management tools.
• Excellent communication, research, and interpersonal skills.

Responsibilities:

Content Creation:

• Develop and update technical documentation for platform engineering, including architectural diagrams, system design documents, and operational procedures.
• Transform complex technical information into easily understandable and actionable content.

Research and Collaboration:

• Collaborate closely with platform engineers, system administrators, and other subject matter experts to gather information.
• Research and analyze intricate technical concepts to ensure accuracy.

Documentation Planning:

• Plan and organize documentation projects, outlining content structure, delivery formats, and schedules.
• Ensure that documentation aligns with platform engineering goals and standards.

Version Control:

• Utilize version control systems to manage document revisions and ensure the accuracy and consistency of documentation.

Visual Aids:

• Create visual aids such as diagrams, charts, and screen captures to enhance the clarity and comprehensibility of documentation.

Editing and Proofreading:

• Review, edit, and proofread documents to maintain clarity, consistency, and adherence to style and branding guidelines.

User Guides and Training Materials:

• Develop user guides, training manuals, and tutorials to support platform engineers and other stakeholders.
• Assist in the creation of training materials and documentation for onboarding new team members.

Compliance and Standards:

• Ensure that documentation meets industry standards, security protocols, and compliance requirements when applicable.

Knowledge Sharing:

• Collaborate with engineering teams to extract, document, and share best practices, patterns, and troubleshooting guides.