| # Documentation Coverage Matrix |
|
|
| Last update: 2026-02-23 |
|
|
| Status values: |
| - `done`: dedicated documentation page exists in `documentations/` and is linked in navigation |
| - `partial`: no dedicated page, but basic in-app guidance exists |
| - `todo`: no dedicated page and limited guidance |
|
|
| | App page | Dedicated doc | Status | Notes | |
| | --- | --- | --- | --- | |
| | `apps/database_page.py` | `documentations/database_doc.py` | done | Main DB generation flow documented | |
| | `apps/core_dump_page.py` | `documentations/core_dump_doc.py` | done | Input/output and parsing behavior documented | |
| | `apps/ue_capability_parser.py` | `documentations/ue_capability_doc.py` | done | Sheets, options, and benchmark mode documented | |
| | `apps/ciq_verification.py` | `documentations/ciq_verification_doc.py` | done | Required files and report structure documented | |
| | `apps/ciq_2g_generator.py` | `documentations/ciq_2g_doc.py` | done | 2G CIQ workflow and optional forbidden BCF documented | |
| | `apps/ciq_3g_generator.py` | `documentations/ciq_3g_doc.py` | done | 3G CIQ parameters and generation flow documented | |
| | `apps/ciq_4g_generator.py` | `documentations/ciq_4g_doc.py` | done | 4G CIQ parameters and generation flow documented | |
| | `apps/gps_converter.py` | `documentations/gps_converter_doc.py` | done | Excel + manual conversion workflows documented | |
| | `apps/distance.py` | `documentations/distance_doc.py` | done | Two-point distance workflow documented | |
| | `apps/multi_points_distance_calculator.py` | `documentations/multi_points_distance_doc.py` | done | Dual-dataset nearest-distance workflow documented | |
| | `apps/sector_kml_generator.py` | `documentations/sector_kml_doc.py` | done | Required columns and KML export documented | |
| | `apps/dbm_watt_calculator.py` | `documentations/dbm_watt_doc.py` | done | Unit conversion modes and constraints documented | |
| | `apps/fnb_parser.py` | `documentations/fnb_parser_doc.py` | done | DOCX extraction and export workflow documented | |
| | `apps/parameters_distribution.py` | `documentations/parameters_distribution_doc.py` | done | Per-parameter distribution analysis documented | |
| | `apps/dump_compare.py` | `documentations/dump_compare_doc.py` | done | Old/new dump comparison and ZIP export documented | |
| | `apps/clustering.py` | `documentations/clustering_doc.py` | done | Clustering methods and map output documented | |
| | `apps/import_physical_db.py` | `documentations/import_physical_db_doc.py` | done | Local physical DB inspection documented | |
| | `apps/dump_analysis.py` | `documentations/dump_analysis_doc.py` | done | Analytics module behavior documented | |
| | `apps/kpi_analysis/gsm_capacity.py` | `documentations/gsm_capacity_docs.py` | done | Dedicated technical/user doc exists | |
| | `apps/kpi_analysis/lte_capacity.py` | `documentations/lte_capacity_docs.py` | done | Dedicated technical/user doc exists | |
| | `apps/kpi_analysis/wbts_capacty.py` | `documentations/wbts_capacity_doc.py` | done | WBTS thresholds and outputs documented | |
| | `apps/kpi_analysis/wcel_capacity.py` | `documentations/wcel_capacity_doc.py` | done | WCEL thresholds/charts/maps documented | |
| | `apps/kpi_analysis/lcg_analysis.py` | `documentations/lcg_analysis_doc.py` | done | LCG analysis flow documented | |
| | `apps/kpi_analysis/gsm_lac_load.py` | `documentations/gsm_lac_load_doc.py` | done | LAC load workflow and filters documented | |
| | `apps/kpi_analysis/lte_drop_trafic.py` | `documentations/lte_drop_traffic_doc.py` | done | Drop detection logic and map output documented | |
| | `apps/kpi_analysis/trafic_analysis.py` | `documentations/trafic_analysis_doc.py` | done | Input/output and usage flow documented | |
| | `apps/kpi_analysis/anomalie.py` | `documentations/anomaly_detection_doc.py` | done | KPI anomaly workflow documented | |
|
|
| ## Next Priorities |
| 1. Add screenshots/examples for each major workflow in documentation pages. |
| 2. Add automated doc lint checks (required sections + link validity). |
| 3. Keep release-note driven doc updates for each new app feature. |
|
|
