1. Identify Documentation Needs

First, identify what documentation needs to be updated or created:

• Review existing documentation to identify gaps or outdated information
• Gather requirements for new features that need documentation
• Prioritize updates based on user needs and feature importance

2. Update or Create Documentation Files

For each documentation item:

1. Locate the appropriate template file in /comserv/Comserv/root/Documentation/
2. Create new files if needed using the existing format (TT template files)
3. Update content with clear, concise information
4. Include examples where appropriate
5. Add cross-references to related documentation

For example, if updating the log form functionality:

• Update or create /comserv/Comserv/root/Documentation/log_system.tt
• Include details about the new project selection feature
• Add screenshots or code examples

3. Migrate Documentation to the New Format

If migrating from an older format:

1. Extract relevant content from the old documentation
2. Restructure according to the new documentation template format
3. Update terminology to be consistent with the current system
4. Enhance with new information about recent features
5. Verify links and cross-references work in the new structure

4. Prepare for Git Commit

Before committing:

1. Review all changes to ensure accuracy and completeness
2. Test documentation links to verify they work
3. Check for formatting issues or inconsistencies
4. Validate any code examples included in the documentation

5. Update the JSON Tracking File

After preparing your documentation but before committing:

1. Open the completed_items.json file:

   /comserv/Comserv/root/Documentation/completed_items.json

2. Add a new entry for each significant documentation update:

   {
     "item": "Updated Log Form Documentation - Added project selection details",
     "status": "completed",
     "date_created": "YYYY-MM-DD",
     "date_completed": "YYYY-MM-DD"
   }

3. Include specific details about what was updated
4. Use consistent formatting for entries
5. Add new fields if needed to capture additional information about the update (e.g., related_features, affected_modules, etc.)

6. Create Git Commit

Follow the Git workflow guidelines:

1. Stage your changes:

   git add /comserv/Comserv/root/Documentation/your_updated_file.tt
   git add /comserv/Comserv/root/Documentation/completed_items.json

2. Create a descriptive commit message:

   git commit -m "Documentation: Updated log form with project selection details"

3. Note the commit hash after committing

7. Update JSON with Commit Information

After committing:

1. Open the completed_items.json file again
2. Add the commit hash to your recent entries:

   {
     "item": "Updated Log Form Documentation - Added project selection details",
     "status": "completed",
     "date_created": "YYYY-MM-DD",
     "date_completed": "YYYY-MM-DD",
     "commit": "a1b2c3d4e5f6" 
   }

3. Commit this update with a simple message:

   git add /comserv/Comserv/root/Documentation/completed_items.json
   git commit -m "Update completed_items.json with commit reference"

8. Push Changes to Repository

Finally:

1. Push your changes to the appropriate branch:

   git push origin your-branch-name

2. Create a pull request if using a branch workflow
3. Notify team members about the documentation updates

Benefits of This Workflow

This workflow ensures:

1. Documentation stays current with system changes
2. Changes are tracked in the JSON file for easy reference
3. Commit information is preserved for traceability
4. Users can see recent updates in the documentation center
5. The application start date is available for reference

By following this structured approach, you'll maintain high-quality documentation that evolves with your system while keeping a clear record of all changes.