Memorable Product Documentation: Following DYI Instructions with Mom

令人难忘的产品文档:与妈妈一起遵循DYI的说明

2021-05-19 05:25 techwhirl

本文共634个字,阅读需7分钟

阅读模式 切换至中文

I was home from college on break when my mother brought home a huge box. Our dog had gnawed the legs of our sofa until they looked like they were covered with tree bark, so inside the box was a small loveseat. Some assembly was required. After we opened the box and compared the paper parts list to the actual parts in the box, we noticed that one item on the parts list was missing–the “Allen wrench”. We had no idea what an Allen wrench was, and there were no pictures of anything in the instructions. And there was no Google or Alexa to ask. In fact, there was no internet. I don’t mean that our internet was down. I mean that there was no such thing as the internet back then. So, we made do without the Allen wrench, but putting the screws in was particularly difficult without it. We used a regular screwdriver as best as we could. As we stood patting ourselves on the back and admiring our handiwork, we saw a mysterious L-shaped piece of metal inside the plastic parts bag. We worried that we had missed a step in the instructions–surely that L must go somewhere in the loveseat. How crucial was that L ? Would our first guest sit on the loveseat and come crashing down to the floor because we couldn’t figure out where the mystery L belonged in the loveseat construction? We re-read the instructions, but there was no mention of an L. We sat on the loveseat ever so gingerly, trying not to put too much weight on it. After seeing that the thing was not going to crash down, we felt very proud of ourselves again. We felt proud, that is, until someone came into the room, picked up the L-shaped piece of metal, and said, “Hey, what is this Allen* wrench doing here?” My mom and I laughed and laughed. In fact, that is one of my favorite memories of my mom. But really, shouldn’t it be called a Larry wrench or something? Because all good tech writers know the value of research, I went to Wikipedia for an informative article on the Allen wrench: “A hex key or Allen key is a simple tool used to drive bolts and screws with hexagonal sockets in their heads. “The tool is usually formed of a single piece of hexagonal rod of hard steel, with blunt ends that are meant to fit snugly into the screw’s socket, bent in an “L” shape with unequal arms. The tool is usually held and twisted by the long arm, creating a large torque at the tip of the short arm. Reversing the tool lets the long arm reach screws in hard-to-reach places. “In 1909–1910, William G. Allen too patented a method of cold-forming screw heads around a hexagonal die (U.S. Patent 960,244). Published advertisements for the “Allen safety set screw” by the Allen Manufacturing Company of Hartford, Connecticut, exist from 1910. Although it is unlikely that Allen was the first person to think of a hex socket drive, his patent for a manufacturing method and his realized product appear to be the first.” Erika Konrad, Ph.D., teaches in the Professional Writing program online through Northern Arizona University. One thing students like about this program is its flexibility: complete an MA or a short Graduate Certificate. In addition to required coursework, Master’s degree students choose 7 electives in professional writing and in a wide variety of other areas such as education, communication, literature, creative writing, travel writing, and memoir. Her newest class, Technical Documentation, brings undergraduates and graduate students together. Everyone learns best practices for content such as product documentation, and graduate students get experience managing teams of writers.
我大学放假回家,妈妈带了一个大箱子回家。我们的狗一直在啃我们的沙发腿,直到它们看起来像覆盖着树皮,所以盒子里是一个小双人沙发。需要进行一些组装。在我们打开箱子并将纸质零件清单与箱子中的实际零件进行比较后,我们注意到零件清单上少了一项——内六角扳手。 我们不知道什么是内六角扳手,说明书上也没有任何图片。也没有谷歌或Alexa可问。事实上,当时没有互联网。我不是说我们的网络瘫痪了。我的意思是那时候没有互联网。所以,我们没有内六角扳手也凑合着用,但是没有内六角扳手拧螺丝特别困难。我们尽可能使用普通螺丝刀。 当我们站在那里拍着胸脯欣赏自己的手艺时,我们看到塑料零件袋里有一块神秘的L形金属片。我们担心我们漏掉了说明中的一个步骤--当然,这个L一定是在沙发的某个地方。这个L有多重要?我们的第一个客人会不会因为我们无法弄清神秘的L在沙发结构中的位置而坐在沙发上,然后摔倒在地? 我们重新阅读了说明书,但是没有提到L。 我们小心翼翼地坐在双人沙发上,尽量不要放太多重量在上面。看到这东西不会倒塌后,我们又为自己感到非常自豪。我们感到很自豪,直到有人走进房间,拿起L形金属片,说:“嘿,这个艾伦*扳手在这里做什么?” 我和妈妈笑了又笑。事实上,那是我对妈妈最喜欢的回忆之一。但说真的,不该叫拉里扳手什么的吗? 因为所有优秀的科技作家都知道研究的价值,所以我在维基百科上找到了一篇关于内六角扳手的内容丰富的文章: 六角扳手或内六角扳手是一种简单的工具,用于拧入头部带有六角套筒的螺栓和螺钉。 这种工具通常由一整根六角硬钢棒组成,其钝端可以紧贴螺丝孔,弯曲成“L”形,两臂不等长。工具通常由长臂握住并扭转,在短臂尖端产生大扭矩。反转工具可以让长臂够到难以够到的地方的螺丝。 1909-1910年,威廉·g·艾伦也申请了一项专利,即在六角形模具周围冷成型螺钉头的方法(美国专利960,244)。康涅狄格州哈特福德的艾伦制造公司发布的“艾伦安全固定螺钉”广告存在于1910年。虽然艾伦不太可能是第一个想到内六角螺丝刀的人,但他的制造方法专利和实现的产品似乎是第一个。” 艾丽卡·康拉德博士通过北亚利桑那大学在线教授专业写作课程。学生们喜欢这个项目的一点是它的灵活性:完成一个硕士学位或一个短期的研究生证书。除了必修课之外,硕士生还要选修7门专业写作和其他领域的课程,如教育、交流、文学、创意写作、旅行写作和回忆录。她的最新课程“技术文档”将本科生和研究生聚集在一起。每个人都学习产品文档等内容的最佳实践,研究生获得管理作者团队的经验。

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文