Wiki Reference Key: Callouts & Codes¶
This wiki uses a few consistent callout boxes, resource codes, and naming conventions to make information easier to recognize and find. Once you know what they mean, you can quickly tell whether something is a key principle, a practical tip, a caution, an example, or a resource that goes with the chapter.
This reference also shows the Markdown syntax used to create each callout and where that type normally appears.
Templates for This Chapter
These boxes point you to the templates, tools, and SOPs that go with the chapter. Resources are listed by their full name and category code so you can match them directly to the files in The Shared Housing System library.
Where it appears: At the end of a chapter.
Markdown: !!! template "Templates for This Chapter"
Example resources:
CHK - Move-Out Inspection Checklist
EML - 30-Day Confirmation and Move-Out Checklist
NTC - Security Deposit Disposition Letter
SOP - Move-Out Process
Companion SOP
A Companion SOP turns the guidance you just read into a repeatable operating procedure. The Manual explains the thinking behind the process. The SOP gives you the condensed procedure for running it.
Each callout names the related SOP and gives you a quick description of what it covers.
Where it appears: With the Manual section the SOP supports.
Markdown: !!! companionsop "Companion SOP"
- SOP - Move-Out Process. Run a move-out from notice through deposit disposition.
Live-In Operator Note
Shared housing works a little differently when the operator lives in the house. These notes point out the places where a live-in operator may need to adapt the standard process.
If the same guidance works for both live-in and off-site operators, there is no separate note.
Where it appears: With the guidance that changes for a live-in operator.
Markdown: !!! livein "Live-In Operator Note"
Key Concept
A Key Concept is a principle worth understanding before you move on. These are the ideas that explain why part of the system works the way it does or that affect how you should think about the process as a whole.
They are not warnings. They are the ideas you do not want to miss.
Where it appears: With the concept it helps explain.
Markdown: !!! keyconcept "Key Concept"
Pro Tip
Pro Tips are practical improvements that can make something easier, faster, cheaper, or smoother.
They are useful, but optional. You do not need every Pro Tip to make the system work.
Where it appears: With the process or step the tip can improve.
Markdown: !!! tip "Pro Tip"
Example
Examples show what the surrounding guidance can look like in a real situation.
They are there to make an idea easier to picture, not to create a new rule. Your property, residents, timing, and local requirements may look different.
Where it appears: With the guidance the example illustrates.
Markdown: !!! example "Example"
Watch Out
Watch Out boxes flag places where it is especially easy to create a problem. That might be a common operational mistake, a failure point in the process, or something that should be checked against local requirements before you proceed.
Think of these as places to slow down and verify what you are doing.
Where it appears: With the decision or action where the problem is most likely to occur.
Markdown: !!! watchout "Watch Out"
Key Concept or Watch Out¶
These two can look similar, but they do different jobs.
A Key Concept explains something you need to understand.
A Watch Out points to something you could easily get wrong.
A useful shorthand is:
- Key Concept: "Here is how this works."
- Watch Out: "Be careful here."
Category Codes¶
Every template in The Shared Housing System library starts with a short category code. The code tells you what kind of resource you are looking at before you even open the file.
Template names follow the same basic format:
CODE - Functional Name
Version numbers are not included when templates are referenced in the Manual.
| Code | Category | What it covers | Ships in |
|---|---|---|---|
| ADS | Listing Ads | Public-facing rental ads and listing copy | Operational |
| ADD | Addenda | Documents that attach to and become part of the lease | Legal |
| AGD | Agendas | Structured agendas for house and operator meetings | Operational |
| AGR | Agreements | Standalone agreements covering services, roles, and consent | Legal |
| CHK | Checklists | Tick-box checklists for recurring or one-time processes | Operational |
| DSC | Disclaimer | The package-level legal disclaimer | Legal |
| EML | Email and Text | Ready-to-send resident and operator messages | Operational |
| FBK | Feedback | Surveys and improvement proposals | Operational |
| FRM | Forms | Structured intake, usually resident-initiated | Both packs |
| LSE | Lease Agreements | Core lease documents | Legal |
| NTC | Notices and Letters | Formal notices, letters, and delivery covers | Legal |
| PRN | Printouts | Resident-facing materials to post or hand out | Operational |
| REF | Reference Guides | Guides explaining how to use a tool, process, or framework | Operational |
| SOP | Standard Operating Procedures | Condensed process guides with context between steps | Manual package only |
| TRK | Trackers | Living spreadsheets updated over time | Operational |
| WKS | Worksheets | Operator-facing fillable worksheets and guided diagnostics | Operational |
Writing Callouts¶
If you are working directly with the Markdown source, all seven callout types follow the same basic structure:
- Begin with the
!!!line followed by the callout type. - Put a custom title in double quotes on the same line.
- Leave one blank line before the callout body.
- Indent every line of the body four spaces.
- Do not use em dashes. The pre-flight check rejects them.
- Avoid format-specific positional language so the same content works in the wiki, print edition, and other outputs.