{"schema":"https://ver.cy/schemas/card/1.0.0","id":"vr.tr.user-guide","code":"thing-q1057179","url":"https://ver.cy/models/thing/q1057179/","name":"user guide","alternateNames":["quick reference handbook","martial arts manual","strategy guide","Aircraft Operations Manual","sample ballot","Herminia","aircraft flight manual","installation manual","laboratory manuals","quickstart guide","construction instruction","video game manual"],"kind":"thing","status":"published","version":"0.2.0-wave.4","language":"en","classifiers":{"family":"Thing Registry","category":"Information and virtual systems","entryKind":"thing","plane":"INF","domain":["INF.KNW"],"industry":[],"navPath":"","tags":[],"facets":{}},"whatItIs":"A document that explains how to use a product, system or service to its users, from quick reference handbooks and software manuals to aircraft operations manuals, video game strategy guides and instructional manuals for skills such as martial arts; the registry aliases also list sample ballot and Herminia, which are not user guides and appear to be misfiled.","purpose":"Let an agent explain user guides and their purpose, relay structure, writing standards and kinds from technical communication sources, describe the kinds the registry aliases name, and distinguish user guides from reference manuals, tutorials, specifications and help systems, noting misfiled aliases.","scope":{"in":[],"out":[],"boundaries":[]},"distinguishingFeatures":["Task oriented","Written for users","Structured","Many domains"],"structure":{"bundles":[{"id":"understand","name":"Understand","description":"What a user guide is.","layers":[{"id":"definition","name":"Definition","description":"Definition.","findings":[{"id":"definition-finding","name":"Definition","description":"Definition.","questions":[{"text":"What is a user guide, and how does it differ from a reference manual, tutorial, specification and help system?","kind":"definition"},{"text":"Is the question about the document type, a kind, writing practice or a misfiled alias?","kind":"boundary"}]}]},{"id":"kinds","name":"Kinds","description":"Kinds.","findings":[{"id":"kinds-finding","name":"Kinds","description":"Kinds.","questions":[{"text":"What are quick reference handbooks, operations manuals, strategy guides and martial arts manuals?","kind":"definition"},{"text":"Which entry fits the specific kind?","kind":"action"}]}]}]},{"id":"writing","name":"Writing","description":"Writing.","layers":[{"id":"structure","name":"Structure","description":"Structure.","findings":[{"id":"structure-finding","name":"Structure","description":"Structure.","questions":[{"text":"How are user guides structured, and what do standards require?","kind":"provenance"},{"text":"Which references are standard?","kind":"provenance"}]}]},{"id":"style","name":"Style","description":"Style.","findings":[{"id":"style-finding","name":"Style","description":"Style.","questions":[{"text":"What writing principles make guides usable, such as task orientation and plain language?","kind":"provenance"},{"text":"Which sources are cited?","kind":"provenance"}]}]}]},{"id":"practice","name":"Practice","description":"Practice.","layers":[{"id":"tools","name":"Tools","description":"Tools.","findings":[{"id":"tools-finding","name":"Tools","description":"Tools.","questions":[{"text":"What tools and formats are used for authoring and publishing guides?","kind":"provenance"},{"text":"Which entry fits technical writing?","kind":"action"}]}]},{"id":"regulated","name":"Regulated","description":"Regulated domains.","findings":[{"id":"regulated-finding","name":"Regulated","description":"Regulated.","questions":[{"text":"How are operations manuals regulated in aviation and safety-critical fields?","kind":"provenance"},{"text":"Which entry fits aircraft flight manual?","kind":"action"}]}]}]},{"id":"context","name":"Context","description":"History and registry note.","layers":[{"id":"history","name":"History","description":"History.","findings":[{"id":"history-finding","name":"History","description":"History.","questions":[{"text":"How did user documentation develop from printed manuals to online help?","kind":"provenance"},{"text":"Which entry fits the history of technical communication?","kind":"action"}]}]},{"id":"aliases","name":"Aliases","description":"Misfiled aliases.","findings":[{"id":"aliases-finding","name":"Aliases","description":"Aliases.","questions":[{"text":"Why are sample ballot and Herminia not user guides?","kind":"provenance"},{"text":"Which entry fits each?","kind":"action"}]}]}]}]},"agentConduct":{"may":["Find, quote and summarise a user guide for the product it belongs to, naming its version.","Follow the steps of a user guide when operating equipment the agent is authorized to use.","Point out where a guide is outdated or contradicts the product."],"mustNot":["Ignore safety warnings in a user guide when operating the product.","Apply instructions from a guide for a different model or version as if they matched.","Remove or alter safety or regulatory content when reproducing a guide.","Reproduce a copyrighted guide in full where the rights holder has not permitted it."],"requiresHuman":["Departing from the guide's instructions on safety-critical equipment, such as aircraft or medical devices.","Publishing corrections to an official guide."]},"ethics":{"considerations":["Users rely on guides for safety; missing or misleading instructions cause injuries.","Guides in only one language or format exclude people who cannot read them."],"affectedParties":["Users of the product","People near operated equipment","The publisher"]},"owners":{"steward":"The maker or publisher of the product the guide documents.","roles":[],"masterSystems":[]},"relations":[{"target":"Q1630279","type":"parent","note":"registry parent class"},{"target":"guideline","type":"related","note":"in registry terms"},{"target":"technical writer","type":"related","note":"in most organisations"},{"target":"reference manual","type":"related","note":"organised by feature"},{"target":"ISO/IEC/IEEE 26514","type":"related","note":"as a standard"}],"interaction":{"identity":{"applicability":"required","items":["Vercy registry: vr.tr.user-guide","Wikidata: Q1057179 (https://www.wikidata.org/wiki/Q1057179)"]},"properties":{"applicability":"not-applicable","items":["standard: ISO/IEC/IEEE 26514 note - user documentation","typical sections: getting started, tasks, troubleshooting list","formats: print, PDF, online help list"]},"recognition":{"applicability":"optional","items":["Instructions for users of a product","Quick reference handbook, aircraft operations manual, strategy guide, martial arts manual","Reference manuals list everything; tutorials teach step by step; specifications define; help systems are embedded","A printed or digital document with instructions, diagrams and procedures."]},"capabilities":{"applicability":"required","items":["explain the document type","relay writing standards","describe kinds","distinguish related documents"]},"hazards":{"applicability":"required","items":["Outdated or inaccurate instructions","Registry aliases misfiled such as sample ballot and Herminia","Confusing guides with reference manuals"]},"interfaces":{"applicability":"required","items":["ISO/IEC/IEEE 26514 and related documentation standards","Product safety laws requiring instructions","Aviation regulations for operations manuals"]},"context":{"applicability":"required","items":["Explaining how to use something.","software and hardware user guides","quick reference handbooks","aircraft and equipment operations manuals","video game strategy guides","skill manuals such as martial arts manuals","online help and knowledge bases"]}},"sources":[{"title":"Wikidata item Q1057179: user guide","url":"https://www.wikidata.org/wiki/Q1057179","note":"identity and sense of the item"},{"title":"Wikipedia: User guide","url":"https://en.wikipedia.org/wiki/User_guide","note":"general description of the item"}],"openQuestions":["Should strategy guide and operations manual be separate primary entries?","How should technical communication sources be linked?","The registry aliases sample ballot and Herminia are not user guides and should be detached"],"resources":{"spec":"/models/things/publications/thing-q1057179/spec.json"},"provenance":{"origin":"thing registry research (pass 2)","builtFrom":["models/things/publications/thing-q1057179/spec.json"],"providers":["Claude"],"researchStatus":"unreviewed","generatedAt":"2026-09-13T14:57:12Z","builder":"tools/build_cards.py@1.0.0"},"completeness":{"sections":{"classifiers":"filled","whatItIs":"filled","purpose":"filled","distinguishingFeatures":"filled","structure":"filled","agentConduct":"filled","ethics":"filled","owners":"filled","relations":"filled","interaction.identity":"filled","interaction.properties":"not-applicable","interaction.recognition":"filled","interaction.capabilities":"filled","interaction.hazards":"filled","interaction.interfaces":"filled","interaction.context":"filled","sources":"filled"},"notes":{"_gate":"Published through the thing publication gate 1.0 on 2026-10-06T19:51:53+00:00: completeness 1.00; sense: Wikidata description; 2 live sources; review by codex: pass","interaction.properties":"Plane INF: no invented physical properties."},"score":1.0}}