Software Spec Writer/Technical Writer NOT Developer
United Global Technologies
Menlo Park, CA, USA
6/14/2022
Education
Full Time
Job Description
Job Description
POSITION SUMMARY | Technical Writer
We are seeking a talented and experienced Technical Writer to join our team. The successful candidate will be responsible for creating, updating, and maintaining technical high-quality documentation for software and systems. You will collaborate with subject matter experts to gather information and develop content that is accurate, concise, and easy to understand for end-users.
As a Technical Writer, your impact on our customer and internal experience will make you a key contributor on the Software Delivery Team to improve customer experience and promote world-class support.
RESPONSIBILITIES AND DUTIES | Technical Writer
- Collaborate with subject matter experts, developers, and product managers to gather information and develop technical documentation including API documentation, user manuals, online help, release notes, and other technical publications.
- Create and maintain content that is accurate, concise, and easy to understand for end-users.
- Familiarity with data governance frameworks, metadata management, and database documentation best practices.
- Collaborate with data architects, governance specialists, and system owners to document data lineage, metadata standards, and database structures in a centralized repository.
- Create clear and accessible documentation for data governance policies, compliance guidelines, and standardization processes to support bureau-wide data initiatives.
- Support the development of risk and compliance documentation, including audit reports, data security policies, and regulatory compliance guidelines.
- Ensure that all documentation adheres to established standards and guidelines.
- Maintain a consistent voice and tone across all documentation.
- Work with cross-functional teams to identify areas for improvement in documentation and make suggestions for updates and enhancements.
- Keep up to date with product changes, new features, and industry trends to ensure accurate and relevant documentation.
- Participate in project planning and provide estimates for documentation efforts.
- Review and edit documentation created by other writers or subject matter experts.
- Publish and distribute documentation in various formats (PDF, HTML, etc.).
POSITION REQUIREMENTS | Technical Writer
- Bachelor's degree in Technical Writing, Computer Science, Software Engineering, Communications, or a related field is preferred.
- 5+ years of experience in technical writing, preferably in data governance, IT policy, or federal documentation.
- Proven experience as a Technical Writer in a software development environment.
- Strong understanding of software development concepts, APIs, and programming languages is a plus.
- Experience with SharePoint, .NET, Confluence/Jira, Git, HTML, CSS, JavaScript, Python, and XML projects is a plus.
- Experience working with documentation workflows and documentation tools.
- Experience working with subject matter experts to gather information and develop technical content.
- Familiarity with version control systems and agile development methodologies.
- Knowledge of technical writing best practices and ability to adhere to established standards and guidelines.