Job Description

Project Overview
Custom software lacks comprehensive documentation, creating challenges in understanding code functionality, business rules, and database structures. To address this, we aim to hire a technical writer to document the software systematically. This documentation will include technical/white papers for designated code modules, processes, business rules, table structures, and data dictionaries.
________________________________________
Project Objectives
1. Provide clear, comprehensive documentation for the custom software.
2. Facilitate knowledge transfer and ease onboarding for new team members.
3. Enable efficient troubleshooting and software maintenance.
4. Standardize and centralize all documentation for future scalability.
________________________________________
Scope of Work
1. Module-Level Documentation
o Breakdown of all designated code modules.
o Description of functionality and interdependencies.
2. Process Documentation
o Overview of software workflows.
o Step-by-step explanation of key processes.
3. Business Rules
o Comprehensive list of business rules embedded in the code.
o Explanation of how rules are applied and their impact on processes.
4. Database Documentation
o Table structures, including field definitions and data types.
o Entity-relationship diagrams (ERDs) to illustrate relationships.
5. Data Dictionary
o Definitions of all database fields and their usage.
o Index of terms and acronyms used across the software.
________________________________________
Approach and Methodology
1. Preparation
o Conduct initial meetings with IT and development teams to identify key areas requiring documentation.
o Create an inventory of modules, processes, and database structures to be documented.
2. Technical Writer Onboarding
o Provide the technical writer with access to software, code repositories, and SMEs (Subject Matter Experts).
o Share existing documentation and relevant materials.
3. Documentation Development
o Follow a structured process:
1. Review code and system behavior.
2. Interview SMEs for additional context.
3. Draft documentation and validate accuracy with the development team.
o Use templates for consistency across all documents.
4. Validation and Review
o Iterative review process involving IT leadership and SMEs.
o Update documentation based on feedback.
5. Finalization and Handoff
o Compile all documents into a central repository.
o Provide training to IT staff on accessing and maintaining documentation.

________________________________________
Deliverables
1. Technical/White Papers for all designated code modules.
2. Comprehensive process documentation.
3. Business rules documentation.
4. Database structure documentation, including ERDs.
5. Data dictionary with field definitions and usage.
________________________________________
Timeline
Phase Duration Milestone
Preparation 2 weeks Find consultant, and setup working area.
Technical Writer Onboarding 1 week Access and knowledge transfer
Documentation Development 10 weeks Drafting and reviews
Validation and Review 4 weeks Feedback incorporation
Finalization and Handoff 2 weeks Document repository setup
Total Project Duration 19 weeks
________________________________________
Resources Needed
1. Personnel
o Technical writer with experience in software documentation.
o SMEs from the IT and development teams.
o Project manager to oversee the documentation effort.
2. Tools
o Documentation software (e.g., Confluence, Microsoft Word, Team, or SharePoint).
o Diagramming tools (e.g., Lucidchart or Visio) for ERDs and workflows.
3. Access
o Code repositories and development environment.
o Existing documentation and technical notes.
________________________________________
Budget Considerations
1. Salary or contract fees for the technical writer.
2. Licenses for documentation and diagramming tools.
3. SME time allocation for interviews and reviews.

All qualified applicants will receive consideration for employment without regard to race, color, national origin, age, ancestry, religion, sex, sexual orientation, gender identity, gender expression, marital status, disability, medical condition, genetic information, pregnancy, or military or veteran status. We consider all qualified applicants, including those with criminal histories, in a manner consistent with state and local laws, including the California Fair Chance Act, City of Los Angeles' Fair Chance Initiative for Hiring Ordinance, and Los Angeles County Fair Chance Ordinance. For unincorporated Los Angeles county , to the extent our customers require a background check for certain positions, the Company faces a significant risk to its business operations and business reputation unless a review of criminal history is conducted for those specific job positions.

Job Tags

Contract work, Local area,

Similar Jobs