Newer
■
■
■
■
■
■
■
■
■
■
Older
59 lines
|
2.044kb
| 1 |
# Research Resources |
|
| 2 | ||
| 3 |
This folder is reserved for external and internal technical material gathered after the original proof-of-concept phase. |
|
| 4 | ||
| 5 |
Use it to collect: |
|
| 6 | ||
| 7 |
- manuals |
|
| 8 |
- vendor specifications |
|
| 9 |
- archived software packages |
|
| 10 |
- vendor contact information |
|
| 11 |
- screenshots or extracts of device information |
|
| 12 |
- protocol notes |
|
| 13 |
- payload descriptions |
|
| 14 |
- decoded and undecoded field mappings |
|
| 15 |
- references to related external projects |
|
| 16 |
- extracted notes derived from external implementations |
|
| 17 | ||
| 18 |
Suggested rule: |
|
| 19 | ||
| 20 |
- keep raw source material close to its origin |
|
| 21 |
- keep interpretation notes in Markdown |
|
| 22 |
- prefer small focused notes over large mixed documents |
|
| 23 | ||
| 24 |
Imported sources can include: |
|
| 25 | ||
| 26 |
- raw PDFs, DOCX, APK, RAR, and similar archival files |
|
| 27 |
- companion README notes describing provenance, duplicates, hashes, and extraction status |
|
| 28 | ||
| 29 |
## Folder Roles |
|
| 30 | ||
| 31 |
- `Manuals/` |
|
| 32 |
Raw manuals and manual inventory notes. |
|
| 33 |
- `Software/` |
|
| 34 |
Raw APKs and notes about retained or intentionally skipped software artifacts. |
|
| 35 |
- `Vendor Contacts/` |
|
| 36 |
Vendor contact documents and extracted contact details. |
|
| 37 |
- `Specifications/` |
|
| 38 |
Curated product and family-level summaries derived from manuals and software. |
|
| 39 |
- `Payload Notes/` |
|
| 40 |
Protocol-facing notes, field maps, framing assumptions, and verification targets. |
|
| 41 |
- `Related Projects/` |
|
| 42 |
External reverse-engineering references that help us compare assumptions. |
|
| 43 | ||
| 44 |
## Retention Policy |
|
| 45 | ||
| 46 |
Keep in git: |
|
| 47 | ||
| 48 |
- source manuals that are directly cited by our notes |
|
| 49 |
- compact software artifacts that are useful for quick inspection |
|
| 50 |
- compact software artifacts that are useful for quick inspection |
|
| 51 |
- extracted Markdown notes that save future reverse-engineering time |
|
| 52 |
- one canonical copy of a duplicated vendor artifact |
|
| 53 | ||
| 54 |
Do not keep in regular git history by default: |
|
| 55 | ||
| 56 |
- very large archives that are expensive to clone and not yet central to active work |
|
| 57 |
- desktop software packages that are unlikely to be used in the current app workflow |
|
| 58 |
- duplicate bundles that do not add new information |
|
| 59 |
- generated intermediate files created only during extraction |