Skip to main content

Migration Notes: Admin Guide v7.5 Integration

Date: 2025-10-08 Status: Completed (Phases 1-4, 6-8) Phase 5 Status: Skipped (content audit deferred)

Changes​

New Structure​

  • 31 focused reference articles (28 planned + 3 additional)
  • Sequential navigation with prev/next links
  • Consolidated v7.5 content (replaces fragmented v9-v15 variants)
  • Diátaxis-compliant organization

Content Sources​

  • Primary: ScrewDrivers Pro/Enterprise Administrator Guide v7.5
  • Format: Converted from DOCX via pandoc and manual extraction
  • Archived: Previous admin-guide content preserved in admin-guide-archive/ (deleted files tracked in git)

Articles Created (31)​

Administrative Foundation (01-08)​

  • 01-admin-console-overview.md
  • 02-admin-console-main-menu.md
  • 03-admin-console-icon-bar.md
  • 04-admin-console-panes.md
  • 05-entities-and-inheritance.md
  • 06-managing-objects.md
  • 07-managing-owners.md
  • 08-managing-assignments.md
  • 09-session-printer-settings.md (additional)

Client Applications (10-11)​

  • 10-endpoint-client-app.md
  • 11-scanning-client-app.md

Session Configuration (20-21)​

  • 20-endpoint-printer-session-settings.md
  • 21-scanning-session-settings.md
  • 30-print-server-overview.md
  • 31-print-server-failover.md
  • 32-print-server-cloud-connector.md
  • 33-print-server-printers.md
  • 34-print-server-updating.md
  • 35-print-server-session-settings.md

Direct Printing (40-42)​

  • 40-direct-printing-overview.md
  • 41-direct-printing-configuration.md
  • 42-direct-printing-session-settings.md

Advanced Features (50-53)​

  • 50-printer-profiles.md
  • 51-legacy-options.md
  • 52-maps-reference.md
  • 53-reports-reference.md

Appendices (60-62, 70)​

  • 60-appendix-endpoint-troubleshooting.md
  • 61-appendix-scanning-troubleshooting.md
  • 62-data-review-overview.md
  • 70-supporting-apps-overview.md

Breaking Changes​

  • URLs have changed for all admin guide articles
  • Previous numeric naming conventions replaced with descriptive names
  • Version-specific variants consolidated to single v7.5 baseline
  • Old files deleted (tracked in git commit history)

Known Issues​

The build process identified broken links from how-to-guides and other sections that still reference the old admin-guide file structure. These need to be updated:

Most frequent broken link targets (now deleted):

  • /reference/admin-guide/ScrewDriversEndpointClients.2.3 → should link to 10-endpoint-client-app.md
  • /reference/admin-guide/ScrewDriversEndpointClients.02.4 → should link to 10-endpoint-client-app.md
  • /reference/admin-guide/ScrewDrivers_Maps.09.03 → should link to 52-maps-reference.md
  • /reference/admin-guide/ScrewDrivers_Reports.10.10 → should link to 53-reports-reference.md
  • /reference/admin-guide/ScrewDrivers_Essentials_* → should link to appropriate new articles

Link update needed in:

  • docs/how-to-guides/configuration/ - LegacyOptions files
  • docs/how-to-guides/general/ - Multiple files referencing old structure
  • docs/how-to-guides/configuration/v7-administration-permissions.md

Phase 5 Status: Content Audit (Deferred)​

Reason for skipping: Per user request to skip Phase 5 and proceed with Phases 6-8.

What was skipped: Audit of 53 archived admin-guide files to identify unique content not covered in new v7.5 guide.

Recommendation: Perform content audit in future work session to:

  1. Identify any unique content in archived files
  2. Integrate valuable content into new articles
  3. Create supplemental articles for version-specific details
  4. Document obsolete content

Archived files location: Deleted files tracked in git history (commit prior to 2025-10-08)

Improvements​

  1. Coherent narrative: Sequential reading path like a product manual
  2. Diátaxis compliance: Narrative style, conversational tone, standalone context
  3. Better navigation: Prev/next links, sidebar ordering, clear hierarchy
  4. Comprehensive coverage: All v7.5 features documented
  5. Rich cross-references: Links to how-to guides, explanations, troubleshooting (where applicable)

Build Status​

  • Build Result: ✅ Success with warnings
  • Warnings: Expected broken links from other sections to old admin-guide files
  • Action Required: Update links in how-to-guides to point to new admin-guide structure

Next Steps​

  1. Update broken links: Fix references from how-to-guides to new admin-guide articles
  2. Complete Phase 5: Perform content audit of archived files (if needed)
  3. Enhance cross-references: Add more links between admin-guide and other sections
  4. Quality review: Run doc-quality-validator on all 31 articles
  5. User testing: Verify sequential navigation and user experience

Completion Date: 2025-10-08 Completed Phases: 1-4, 6-8 Pending Phase: 5 (Content Audit)