Wiki Initialization and Update Checklist

Wiki Initialization and Update Checklist

中文

Last updated: 2026-07-22

This page is the single execution checklist for initializing the Screen Remote wiki. The current uncommitted diff does not determine documentation scope, and the existing 61 Chinese developer pages are not assumed to deserve preservation. The work first establishes the information architecture, then verifies every page against the complete current code, tests, and build configuration and explicitly decides whether to keep, merge, split, archive, or delete it.

Completion criteria

An existing page may be marked dispositioned only when all of the following are true:

• Its role is known: entry point, current canonical fact, usage guide, troubleshooting, research record, plan, or handoff.
• Its disposition is explicit: keep, merge and delete, split and reorganize, archive, or delete. Old filenames are not preserved by creating duplicate canonical pages.
• Its owning code boundary, entry points, key states, and relevant tests have been identified.
• Obsolete conclusions have been removed, replaced, or explicitly labeled. Research notes do not present themselves as the current implementation.
• Every retained page has complete English and Chinese counterparts with readable filenames in their own language and reciprocal links near the top. Deleted pages do not receive empty shells.
• Retained Chinese and English pages have equivalent knowledge in their sections, tables, configuration values, code paths, limitations, and regression checks.
• Page links resolve, and no other wiki page continues to spread the same obsolete fact.

Information architecture

Layer	Responsibility	Rule
Home and sidebar	Shortest navigation	Keep only stable entry points; do not carry technical detail.
Developer overview	Select a reading path by task	Do not duplicate topic content.
Technical index	List all maintained technical pages	Each subject points to one canonical page.
Architecture/topic/guide	Carry current facts	Code, tests, and build configuration are authoritative.
Analysis/troubleshooting	Provide signals, decision trees, and repair boundaries	Separate symptom, cause, evidence, and action.
Research/design	Preserve reusable research conclusions	Distinguish external references, candidates, and implemented behavior.
Plan/handoff	Track unfinished work	Move completed facts into canonical pages; do not present TODOs as current behavior.

Page dispositions

Disposition	When to use it	Result
Keep	The subject is independent, durable, and the best ownership boundary for the facts.	Rewrite it as the canonical current page and create a complete English counterpart.
Merge and delete	It duplicates another page and contains only a small amount of unique information.	Merge unique facts into the canonical page, repair inbound links, and delete the old page.
Split and reorganize	It mixes multiple ownership boundaries and cannot be maintained reliably.	Distribute facts among existing or new canonical pages, then delete the original page.
Archive	The record still has research value but does not describe current behavior.	Retain necessary context, label its date, source, and non-authoritative status, and create an English counterpart only when useful.
Delete	It has no unique fact, is fully obsolete, or records only a one-off process.	Repair inbound links and delete it without creating an English counterpart.

Execution order

Phase 0: Framework and entry points

• Home.md
• _Sidebar.md
• 开发文档.md
• 开发文档-技术文档索引.md
• 开发文档-文档维护约定.md
• 开发文档-初始化与更新清单.md

Phase 1: Project overview and build facts

• 开发文档-概览-项目定位.md
• 开发文档-概览-当前能力范围.md → merged into Project Positioning and Capability Boundary, then deleted
• 开发文档-概览-构建与入口.md
• 开发文档-近期关键更新.md → duplicated canonical topics and contained stale values; deleted
• 开发文档-scrcpy-升级记录.md
• 开发文档-dadb-集成说明.md

Phase 2: Architecture and runtime path

• 开发文档-架构.md
• 开发文档-架构-架构原则.md → merged into Module Map and Boundaries, then deleted
• 开发文档-架构-模块地图.md
• 开发文档-架构-目录与边界规则.md → merged into Module Map and Boundaries, then deleted; removed file-length hard rules that were not tool-enforced
• 开发文档-架构-运行时主链路.md
• 开发文档-架构-会话状态与事件.md
• 开发文档-架构-会话配置与连接生命周期.md

Phase 3: ADB, connection, and session configuration

• 开发文档-接入指南.md
• 开发文档-专题-ADB-USB-与无线.md
• 开发文档-指南-ADB-连接生命周期.md → removed the obsolete delayed-ACK product profile and documented the current primary/streaming lane model
• 开发文档-指南-设备配对与无线调试.md
• 开发文档-指南-会话配置与更新规则.md → merged into Session Configuration and Connection Lifecycle, then deleted
• 开发文档-指南-会话参数选择器.md
• 开发文档-交接-USB-与-Wireless-Debugging-当前状态.md → merged current facts into the ADB topic and pairing guide, then deleted

Phase 4: scrcpy, media, control, and remote interaction

• 开发文档-专题-编码与解码.md
• 开发文档-指南-编解码器配置.md → merged into Encoding and Decoding, then deleted
• 开发文档-分析-Metadata-与编解码器分析.md → merged protocol-reading and troubleshooting facts into Encoding and Decoding, then deleted
• 开发文档-专题-远程生命周期与事件.md → moved lifecycle facts to the architecture runtime path and input/Surface facts to interaction performance, then deleted
• 开发文档-专题-远程交互性能与悬浮菜单.md
• 开发文档-专题-剪贴板同步.md
• 开发文档-研究-Server-Socket-与控制流细节.md → merged current facts into Runtime Main Path and interaction performance, then deleted
• 开发文档-研究-传输控制流与缓冲结论.md → removed speculative buffer advice and merged implemented control-flow facts into interaction performance, then deleted
• 开发文档-研究-编解码器策略-Low-Latency-与-C2.md → merged maintainable conclusions into Encoding and Decoding; removed the one-off incident report as a canonical page

Phase 5: Management, logging, events, and troubleshooting

• 开发文档-专题-管理功能.md
• 开发文档-管理页能力说明.md → merged the current seven sections and capability boundaries into Management Features, then deleted
• 开发文档-指南-事件系统与-Shell-接入.md
• 开发文档-指南-事件流监控与采样.md → merged bus, monitor, and sampling facts into the event/Shell guide, then deleted
• 开发文档-专题-日志系统.md
• 开发文档-指南-日志维护指南.md → merged output, categories, tags, and audit rules into Logging System and Maintenance, then deleted
• 开发文档-排障与分析.md
• 开发文档-分析-排障方法.md → merged into Layered Troubleshooting Method, then deleted
• 开发文档-分析-日志与信号字典.md → merged tags and phase signals into canonical logging and troubleshooting pages, then deleted
• 开发文档-分析-Control-Idle-Disconnect-Fix.md → merged the current keepalive invariant into troubleshooting and deleted the one-off fix record

Phase 6: UI, bilingual text, and engineering rules

• 开发文档-专题-UI-设计.md → rewritten as the canonical design-system page with a complete English counterpart
• 开发文档-专题-双语设计.md → rewritten against TextPair and the current text objects with a complete English counterpart
• 开发文档-设计-iOS-风格设计方案.md → durable design principles merged into UI Design System, then deleted
• 开发文档-分析-远程-UI-布局分析规则.md → rewritten against the parser, models, overlay, and tests with a complete English counterpart
• 开发文档-分析-Edit-Session-Dialog-Layout-Notes.md → durable layout conclusions merged into UI Design System, then deleted
• 开发文档-规范-工程规则.md → expanded into the unified engineering and verification baseline with a complete English counterpart
• 开发文档-规范-协作规则.md → useful collaboration constraints merged into Engineering and Verification Rules, then deleted
• 开发文档-规范-开发测试与性能约束.md → test and performance rules merged into the canonical page, then deleted
• 开发文档-规范-Android-AI-重构规范.md → useful refactoring boundaries merged into the canonical page; the repetitive long-form rule set was deleted

Phase 7: Research, plans, and handoff

• 开发文档-技术研究.md → rewritten as the canonical External Research and Trade-offs entry with a complete English counterpart
• 开发文档-专题-友商分析.md → reference targets and adoption principles merged into the research entry, then deleted
• 开发文档-研究-外部实现对比结论.md → durable protocol, strategy, and architecture trade-offs merged into the research entry, then deleted
• 开发文档-研究-iOS-Adaptation-Code-Audit.md → useful design-system conclusions already merged into UI Design System; the audit snapshot was deleted
• 开发文档-研究-iOS-Asset-Mapping.md → applied assets are represented by code; selection principles merged into the research entry, then deleted
• 开发文档-研究-iOS-Prototype-Session-Edit-Page-Analysis.md → durable token and form conclusions merged into UI Design System, then deleted
• 开发文档-研究-iOS-Prototype-Window-And-Sizing-Analysis.md → responsive and window conclusions merged into UI Design System, then deleted
• 开发文档-计划-Miuzarte-可借鉴项落地清单.md → mixed completed work, tasks, and historical judgments; deleted from the initial wiki
• 开发文档-计划-UI-全量优化-TODO.md → volatile implementation planning belongs in issues; deleted
• 开发文档-交接-开放问题与后续项.md → volatile handoff tracking belongs in issues; stable invariants are already covered by canonical topics, so it was deleted

Per-page workflow

1. Read the page and its directly linked canonical pages; mark duplication and conflicts.
2. Locate the owning packages, build files, main-path entry points, and tests for the subject.
3. Choose keep, merge, split, archive, or delete. First consolidate any retained canonical Chinese facts, then create the English counterpart.
4. Search the entire wiki for equivalent stale wording and correct every page that would misrepresent the current implementation.
5. Run subject-specific tests or static checks, then validate bilingual structure, links, and Markdown diffs.
6. Change an item to [x] only after all checks above pass.

Current progress

• Original Chinese developer-page candidates included in the disposition checklist: 61; all have been dispositioned
• Maintained developer documentation: 30 Chinese pages and 30 complete English counterparts
• The full wiki now contains 79 pages, including complete bilingual user documentation and navigation pages
• Final acceptance: links, bilingual structure, stale facts, Markdown, unit tests, and the Debug build