Developer Documentation

Developer Documentation

中文

This area is for Screen Remote developers. It contains current architecture, runtime paths, subsystem boundaries, troubleshooting methods, engineering rules, and research conclusions that remain useful.

The wiki is undergoing its first systematic construction pass. Existing pages are not preserved by default; each one must be verified against code and receive an explicit keep/merge/split/archive/delete decision. Wiki Initialization and Update Checklist is authoritative for current scope and progress.

Enter by task

• Build a project-level understanding: start with Project Positioning and Build and Entry Points.
• Change architecture or runtime behavior: read Architecture and Runtime Main Path first.
• Integrate or modify a subsystem: enter the owning topic from Integration Guide.
• Diagnose a failure: start with the layered decision path in Troubleshooting and Analysis.
• Evaluate a candidate approach: start with Technical Research, but do not treat research pages as the current implementation.

Documentation layers

1. Technical Documentation Index: locate the final retained canonical pages.
2. Architecture, topics, and guides: describe current implementation and durable boundaries.
3. Analysis and troubleshooting: describe signals, causes, decision trees, and repair boundaries.
4. Research and design: preserve reusable conclusions while distinguishing implemented and candidate approaches.
5. Plans and handoffs: contain only unfinished work; completed facts move into canonical pages.

Required entry points

• Wiki Initialization and Update Checklist
• Documentation Maintenance Conventions
• Technical Documentation Index
• Engineering Rules

Authority rules

• Build files, current source, and tests take precedence over old wiki conclusions.
• One fact has one canonical detail page; entry pages provide navigation only.
• Every retained Chinese topic page has a complete English counterpart.
• A page not completed in the checklist remains audit material and is not guaranteed to represent current code.