Get new jobs for this search by email

Talent Acquisition Manager with Roth Staffing

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
   - Breakdown of all designated code modules.
   - Description of functionality and interdependencies.
2. Process Documentation
   - Overview of software workflows.
   - Step-by-step explanation of key processes.
3. Business Rules
   - Comprehensive list of business rules embedded in the code.
   - Explanation of how rules are applied and their impact on processes.
4. Database Documentation
   - Table structures, including field definitions and data types.
   - Entity-relationship diagrams (ERDs) to illustrate relationships.
5. Data Dictionary
   - Definitions of all database fields and their usage.
   - Index of terms and acronyms used across the software.

Approach and Methodology

1. 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.
2. Technical Writer Onboarding
   - Provide the technical writer with access to software, code repositories, and SMEs (Subject Matter Experts).
   - Share existing documentation and relevant materials.
3. Documentation Development
   - 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.
   - Use templates for consistency across all documents.
4. Validation and Review
   - Iterative review process involving IT leadership and SMEs.
   - Update documentation based on feedback.
5. Finalization and Handoff
   - Compile all documents into a central repository.
   - 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

1. Preparation - 2 weeks - Find consultant, and setup working area.
2. Technical Writer Onboarding - 1 week - Access and knowledge transfer
3. Documentation Development - 10 weeks - Drafting and reviews
4. Validation and Review - 4 weeks - Feedback incorporation
5. Finalization and Handoff - 2 weeks - Document repository setup

Total Project Duration: 19 weeks

Resources Needed

1. Personnel
   - Technical writer with experience in software documentation.
   - SMEs from the IT and development teams.
   - Project manager to oversee the documentation effort.
2. Tools
   - Documentation software (e.g., Confluence, Microsoft Word, Team, or SharePoint).
   - Diagramming tools (e.g., Lucidchart or Visio) for ERDs and workflows.
3. Access
   - Code repositories and development environment.
   - 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.