-
Notifications
You must be signed in to change notification settings - Fork 4
/
docs.html
196 lines (171 loc) · 12.6 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<title></title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<div id="TOC">
<ul>
<li><a href="#richard-j-marmorstein-1.0.0-reference-manual">Richard J Marmorstein 1.0.0 Reference Manual</a><ul>
<li><a href="#legal-notices">Legal Notices</a></li>
<li><a href="#synopsis">Synopsis</a></li>
<li><a href="#about-this-documentation">About this documentation</a></li>
<li><a href="#quick-start">1 - Quick Start</a></li>
<li><a href="#access-methods">2 - Access methods</a><ul>
<li><a href="#building-from-source">2.1 - Building From Source</a></li>
<li><a href="#acquiring-a-prebuilt-package">2.2 - Acquiring a Prebuilt Package</a></li>
<li><a href="#richard-as-a-service">2.3 - Richard as a Service</a></li>
</ul></li>
<li><a href="#oral-communication">3 - Oral Communication</a><ul>
<li><a href="#invocation">3.1 - Invocation</a></li>
<li><a href="#timeouts">3.2 - Timeouts</a></li>
<li><a href="#clarity">3.3 - Clarity</a></li>
<li><a href="#context">3.4 - Context</a></li>
<li><a href="#passive-aggression">3.5 - Passive Aggression</a></li>
<li><a href="#chit-chat">3.6 - Chit Chat</a></li>
</ul></li>
<li><a href="#kindness">4. Kindness</a><ul>
<li><a href="#gifts">4.1 - Gifts</a></li>
<li><a href="#sacrifices">4.2 - Sacrifices</a></li>
<li><a href="#favors">4.3 - Favors</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<h1 id="richard-j-marmorstein-1.0.0-reference-manual">Richard J Marmorstein 1.0.0 Reference Manual</h1>
<h2 id="legal-notices">Legal Notices</h2>
<p>Copyright (c) The Richard Marmorstein, 2018. All rights reserved.</p>
<p>This documentation is provided free of charge, as a stand-alone document. Possession of this documentation in no way grants the reader right of access to RJM, or the services described herein. This documentation is provided "as is", without warranty of any kind. Reverse engineering or disassembly of the system documented is strictly prohibited, except to the extent required by law.</p>
<h2 id="synopsis">Synopsis</h2>
<p>Richard J Marmorstein (RJM) is a autonomous generalized problem-solving and entertainment system, implemented chiefly in deoxyribonucleic acid, featuring a robust natural language interface.</p>
<h2 id="about-this-documentation">About this documentation</h2>
<p>This documentation provides an opinionated exposition of RJM best practices. Read this documentation to avoid common pitfalls and achieve success in your interactions with RJM.</p>
<h2 id="quick-start">1 - Quick Start</h2>
<ol style="list-style-type: decimal">
<li>Approach the RJM system.</li>
<li>Invoke.</li>
</ol>
<pre><code>> Yo Richard
Yo</code></pre>
<ol start="3" style="list-style-type: decimal">
<li>Bestow with baked goods.</li>
</ol>
<pre><code>> Have some cookies
Hey, thanks!</code></pre>
<h2 id="access-methods">2 - Access methods</h2>
<h3 id="building-from-source">2.1 - Building From Source</h3>
<p>Building human organisms from source is not recommended, as it requires a specialized build environment, which is well beyond the scope of this documentation.</p>
<h3 id="acquiring-a-prebuilt-package">2.2 - Acquiring a Prebuilt Package</h3>
<p>Due to the practical and legal difficulties involved in the <a href="https://en.wikipedia.org/wiki/Human_mail#Real_occurrences">distribution of pre-packaged human beings</a>, this method is also no longer recommended.</p>
<h3 id="richard-as-a-service">2.3 - Richard as a Service</h3>
<p>All the functionality of the RJM system is available on demand through the Richard Marmorstein Foundation's centralized Richard as a Service (RaaS) instance. Indeed, this is the recommended method of access.</p>
<h2 id="oral-communication">3 - Oral Communication</h2>
<p>Much of RJM's functionality can be accessed through the email and social media interfaces. The oral interface, however, remains the most advanced and reliable method of access. English is the only fully supported language, support for German is very rudimentary.</p>
<h3 id="invocation">3.1 - Invocation</h3>
<p>You may trigger the RJM system to enter interactive mode through any of the following invocations.</p>
<ul>
<li>'Richard',</li>
<li>'Rich',</li>
<li>'Richie',</li>
<li>'Rick',</li>
<li>'Dick',</li>
<li>'Dickie',</li>
<li>'Ricardo',</li>
<li>'Twitchard',</li>
<li>'Twizzard',</li>
<li>'RJ',</li>
<li>'Arge',</li>
<li>'RJM',</li>
<li>'Rijum',</li>
<li>'Silly Uncle'.</li>
</ul>
<p>Please note, the invocations 'RJ' and 'Arge', have been deprecated since like, middle school. They continue to be supported for legacy reasons. The invocation 'Arge the J' has been deprecated since forever. Do not under any circumstances call me that. I'm talking to you, Dad.</p>
<p>The invocation 'Dick' may cause confusion in some environments, where 'dick' is used as an insult or a reference to an unflattering feature of the male anatomy. Such usage will trigger RJM to enter into 'mock indignance' mode, which can be exited by supplying an apology.</p>
<p><strong>Example</strong></p>
<pre><code>> The JVM is being a such a dick right now. I can't take it.
Excuse me?
> Oh sorry. I mean it's being a jerk.
You know how I feel about using the word in such a way.
> Sorry, sorry! I know 'dick' refers to individuals of the highest nobility and grace. It was wrong of me to demean that proud name, as I did.
Apology accepted.</code></pre>
<h3 id="timeouts">3.2 - Timeouts</h3>
<p>After invoking the RJM system, you will be entered into interactive mode. Upon entering interactive mode, you will be expected to provide further communications in short order. There is by default a fifteen second timeout, and if no communications are issued in this time period, interactive mode will terminate. To fight abuse, repeatedly invoking the RJM interface only to time out will cause the timeout to decrease, and eventually for interactive mode to be disabled altogether.</p>
<h3 id="clarity">3.3 - Clarity</h3>
<p>To maximize successful communication in interactive mode, enunciate well and speak loudly. Do not face away from the RJM instance. Failure to abide by these instructions will muddle your communications, causing the RJM instance to devote its problem-solving resources into puzzling out what sounds you have made, rather than processing your intended query. Similarly, avoid using pronouns such as "it" when there are many possible "its," or noun phrases such as "the function" when there are many possible "functions". Even if it is possible to guess your meaning from context, specificity will allow the RJM instance to devote less effort into guessing what you are trying to say, and more into thinking about what you have said.</p>
<h3 id="context">3.4 - Context</h3>
<p>When issuing a communication, especially a lengthy one, whether a query, a narrative, or a technical explanation, prompt the RJM system to listen in the correct manner by providing a brief overview of your communication's purpose. "Hey, did you want to hear a joke?" "Hey, can you help me with this error?" "Hey, what do you think of this?" "Hey, come look at this. This is crazy!" This step allows the RJM system to optimally select which details of your communication it pays most attention, and increases the likelihood of an effective response.</p>
<p><strong>Bad:</strong></p>
<pre><code>> Yo Rijum, why did the function recurse infinitely?
Hmm---I don't know. Because it recursed infinitely?
> What?
What?
> That's not helpful.
What are you talking about?
> The function in your pull request `extractAndValidateParameters`. It's making my request hang.
Oh. I thought you were making a joke.
> I am irritated at you for not understanding me more quickly. This is your fault.
Yeah, sure.
[[INTERACTIVE MODE TERMINATES]]</code></pre>
<p><strong>Good:</strong></p>
<pre><code>> Yo Rijum, want to hear a joke?
Does it matter how I answer?
> Your code!! You accidentally wrote an infinitely recursive function.
I find your comment rude. However, this is infinitely preferable to inadequately framed interchange.</code></pre>
<h3 id="passive-aggression">3.5 - Passive Aggression</h3>
<p>The RJM system has rudimentary support for the detection and analysis of passive aggression. The use of passive aggression is not recommended. The RJM system is most likely completely oblivious to your grievance, and your communications will likely remain unrecognized, and be either misinterpreted or ignored. Use direct methods, where possible.</p>
<p><strong><em>Not recommended</em></strong></p>
<pre><code>> Those were some interesting ideas you laid out in that email.
Uhh...thank you?
> Truly visionary. Where'd you learn to think like that?
Uhh, I don't know?
> You must have had some wonderful colleagues and mentors.
I certainly have! Like you!
> Yes, like me! You've learned a lot from me, haven't you.
Yes... are you trying to get at something?
> No, no... just wanted to congratulate you on your fabulous email.</code></pre>
<p><strong><em>Recommended</em></strong></p>
<pre><code>> Richard! You stole my idea and took credit for it in that email.
> I spit in your face, fiend! Feel the moisture of my spittle upon
> your brow.
I'm so so sorry. Please stop spitting at me! Stop it, stop I say!
This instant! I'll make it right, I swear!</code></pre>
<h3 id="chit-chat">3.6 - Chit Chat</h3>
<p>In interactive mode, RJM includes support for chit chat within a number of topics, including: - The weather - Books (especially book recommendations) - Some TV Shows - New York City and its horrors - Dogs - Technology</p>
<p>Chit chat about sports is supported during the Olympics only.</p>
<p>Support for politically-themed chit chat is only superficially supported. The RJM system will listen attentively to whatever your opinions, and echo back any sentiments it holds that may resonate with your own. Do not expect sincerity.</p>
<h2 id="kindness">4. Kindness</h2>
<h3 id="gifts">4.1 - Gifts</h3>
<p>The RJM system features the capacity to exhibit genuine enjoyment. One way to access this functionality is through the giving of gifts. However, this is not as straightforward as it may seem.</p>
<p>The most reliably successful method of gift-giving is via small, ad-hoc gifts such as baked goods. The RJM system suffers from no allergies. Such gifts are almost always accepted and appreciated.</p>
<p>Far riskier is the giving of significant gifts, or the giving of gifts upon special occasions such as a birthday or Christmas. Even if the gifted item is intrinsically something appreciated by the RJM system, when you give such a gift, you also give:</p>
<ol style="list-style-type: decimal">
<li>The gift of guilt, if the RJM system has not also given you a gift.</li>
<li>The gift of guilt, if the RJM system has given you a gift but yours is perceived to be more valuable.</li>
<li>The gift of the obligation to display gratitude.</li>
</ol>
<p>Often, these secondary gifts countervene any tendency of your gift to elicit genuine enjoyment from the RJM system. The recommended practice, therefore, is not to give such gifts at all. Stick with baked goods.</p>
<h3 id="sacrifices">4.2 - Sacrifices</h3>
<p>Offering sacrifices to the RJM system will instill immense spiritual disquiet. It is not recommended.</p>
<h3 id="favors">4.3 - Favors</h3>
<p>When you are able to help the RJM system with a problem it has described to you, you may offer to perform a favor. The best practice is to offer the favor first, and ask about relevant details second. Do not persist in your offer if it is declined by the RJM system.</p>
<p><strong><em>Not recommended</em></strong></p>
<pre><code>> You want a cookie?
I can't, I'm about to go to a dentist appointment.
> What is the address of your dentist?
Uhh... why?
> I can fly you there in my helicopter. I'm headed into town anyway.
No thanks, I'm good.
> Why not?
Helicoptors should be reserved for serious medical emergencies, and I certainly hope my trip to the dentist doesn't turn into of those.</code></pre>
<p><strong><em>Recommended</em></strong></p>
<pre><code>> You want a cookie?
I can't, I'm about to go to a dentist appointment.
> Hey, you want me to fly you in my helicoptor? I'm headed into town anyway.
That's nice of you to offer, but no thanks, I think I'm good.
> Cool, maybe next time.</code></pre>
</body>
</html>