Ciber
Technical Writer Job at Ciber in Tampa
Ciber - Tampa, FL, United States, 33646
Work at Ciber
Overview
- View job
Overview
HTC Global Services wants you. Come build new things with us and advance your career. At HTC Global you'll collaborate with experts. You'll join successful teams contributing to our clients' success. You'll work side by side with our clients and have long-term opportunities to advance your career with the latest emerging technologies.
At HTC Global Services our consultants have access to a comprehensive benefits package. Benefits can include Paid-Time-Off, Paid Holidays, 401K matching, Life and Accidental Death Insurance, Short & Long Term Disability Insurance, and a variety of other perks.
Scope of Work
Module-Level Documentation Breakdown of all designated code modules.
Description of functionality and interdependencies.
Process Documentation Overview of software workflows.
Step-by-step explanation of key processes.
Business Rules Comprehensive list of business rules embedded in the code.
Explanation of how rules are applied and their impact on processes.
Database Documentation Table structures, including field definitions and data types.
Entity-relationship diagrams (ERDs) to illustrate relationships.
Data Dictionary Definitions of all database fields and their usage.
Index of terms and acronyms used across the software.
Approach and Methodology Preparation Conduct initial meetings with IT and development teams to identify key areas requiring documentation.
Create an inventory of modules, processes, and database structures to be documented.
Technical Writer Onboarding Provide the technical writer with access to software, code repositories, and SMEs (Subject Matter Experts).
Share existing documentation and relevant materials.
Documentation Development Follow a structured process: Review code and system behavior.
Interview SMEs for additional context.
Draft documentation and validate accuracy with the development team.
Use templates for consistency across all documents.
Validation and Review Iterative review process involving IT leadership and SMEs.
Update documentation based on feedback.
Finalization and Handoff Compile all documents into a central repository.
Provide training to IT staff on accessing and maintaining documentation.
Deliverables Technical/White Papers for all designated code modules.
Comprehensive process documentation.
Business rules documentation.
Database structure documentation, including ERDs.
Data dictionary with field definitions and usage.
Resources Needed: Personnel Technical writer with experience in software documentation.
SMEs from the IT and development teams.
Project manager to oversee the documentation effort.
Tools Documentation software (e.g., Confluence, Microsoft Word, Team, or SharePoint).
Diagramming tools (e.g., Lucidchart or Visio) for ERDs and workflows.
Access Code repositories and development environment.
Existing documentation and technical notes.
Our success as a company is built on practicing inclusion and embracing diversity. HTC Global Services is committed to providing a work environment free from discrimination and harassment, where all employees are treated with respect and dignity. Together we work to create and maintain an environment where everyone feels valued, included, and respected. At HTC Global Services, our differences are embraced and celebrated. HTC is an Equal Opportunity Employer. We respect and seek to empower each individual and support the diverse cultures, perspectives, skills, and experiences within our workforce. HTC is proud to be recognized as a National Minority Supplier