Technical Writer Intern

Job Description

The Technical Writer Intern will assist in creating, organizing, and maintaining system documentation throughout the software development lifecycle (SDLC), from requirement analysis and system design to development, testing, deployment, and maintenance. The intern will work closely with Business Analysts, System Analysts, Developers, QA Engineers, and DevOps Engineers to ensure that project and technical documentation is well-structured, accurate, consistent, and easy to understand.

Responsibilities

1. Assist in preparing and maintaining project documentation based on requirements and information provided by Business Analysts.
2. Assist in preparing Functional Specifications, including business processes, functional flows, business rules, and application behavior.
3. Assist in preparing Technical Specifications based on system design, architecture, APIs, databases, and technical behavior provided by System Analysts and Developers.
4. Document system changes, enhancements, and bug fixes throughout the development and maintenance process.
5. Assist in preparing supporting development documentation, such as API Documentation, System Documentation, and Technical References.
6. Assist in preparing deployment guides, configuration guides, release notes, and other documentation required for system implementation.
7. Review and update documentation based on system changes and validation feedback from relevant stakeholders.
8. Ensure documentation follows established templates, writing standards, and documentation structures.
9. Collaborate with Business Analysts, System Analysts, Developers, QA Engineers, and DevOps Engineers to gather information and ensure documentation accuracy.
10. Help organize and maintain documentation to ensure it is accessible, understandable, and up to date throughout the software development lifecycle.

Requirements

1. Currently pursuing or recently graduated from a degree in Computer Science, Information Systems, Information Technology, or a related field.
2. Interested in application development and IT system documentation.
3. Good writing skills with the ability to organize information in a clear, structured, and easy-to-understand manner.
4. Strong analytical skills and the ability to understand technical information and business processes.
5. Good communication and collaboration skills.
6. Detail-oriented, proactive, and willing to learn.
7. Familiar with Microsoft Word, Excel, or Google Docs.
8. Basic understanding of the Software Development Lifecycle (SDLC).
9. Willingness to learn about requirements documentation, Functional Specifications, Technical Specifications, and application documentation.

Preferred Qualifications

1. Basic understanding of Business Analyst or System Analyst responsibilities.
2. Experience creating project documentation, reports, or technical documentation.
3. Basic understanding of databases, APIs, JSON, or application architecture.
4. Familiarity with Markdown, Git, Swagger/OpenAPI, Confluence, or other documentation tools.
5. Experience using web applications and understanding application workflows.
6. Knowledge of or interest in investment, finance and financial management, and insurance.
7. Basic understanding of business processes or transactions within the investment, financial services, or insurance industries.

Expected Deliverables

1. Functional Specification documentation prepared based on requirements and analysis provided by Business Analysts.
2. Technical Specification documentation prepared based on technical information provided by System Analysts and Developers.
3. Updated system documentation reflecting changes during development and maintenance.
4. Deployment and implementation documentation prepared according to project requirements.
5. Documentation that follows established standards, templates, and structures.

Learning Opportunities

The Technical Writer Intern will have the opportunity to learn and understand application development processes, business workflows, system design, technical specifications, and system implementation and maintenance documentation. The intern will gain practical experience collaborating with different IT roles and contributing to documentation throughout the software development lifecycle.