Weekly Writing Assignment, Week 8

Write a 250-word memo addressed to Prof. Ellis with the subject, “Other Sections for Instruction Manual,” in which you strategize what other sections to include in your instruction manual document. Below, you will find some suggestions. Also, look at the Instructions chapter and Instruction examples in David McMurrey’s Online Technical Writing Textbook for models that you can look to about how they are organized. Copy-and-paste your memo into a comment made to this post.

1.0    Introduction
1.1    Purpose
1.2    Intended Audience
1.3    Scope
1.4    Organization Description
1.5    Conventions (abbreviations, left/right)
1.6    Motivation (answers the “so what” question)
1.7    Safety and Disclaimers
2.0    Description of the Equipment
2.1    Illustration of the Equipment
2.2    Description of the Equipment’s Parts
3.0    List of Materials and Equipment Needed
3.1    Illustration of the Parts Needed to Carry Out the Instructions
3.2    Tools needed
3.3    Table of the parts with description of each
4.0    Directions
4.1    Assemble the Skateboard
4.1.1    Step 1 (don’t write Step 1--write a brief statement on what the first step is)
4.1.2    Step 2
4.1.3    Step 3...Step n (write as many steps--briefly--as you can think of--you can fill this list out later)
5.0    Troubleshooting
6.0    Glossary
7.0    Reference List

12 thoughts on “Weekly Writing Assignment, Week 8”

  1. To: Prof. Jason Ellis
    From: Michael Vanunu
    Date: Nov. 3, 2021
    Subject: Other Sections for Instruction Manual

    1.0 Introduction – explaining the point of the instruction manual.
    1.1 Purpose – what the purpose of the manual is.
    1.2 audience – the intended audience it is for.
    1.3 Explaining the objectives – how are we gonna achieve what we want .
    1.4 Explaining the goals – what are we going to achieve.
    1.5 Picking a program – intelliJ will be used.
    1.6 Understanding how to use the program – basics of intelliJ.
    1.7 Understanding syntax – the wrongs and rights when writing java.
    2.0 Explaining basic commands – going over commands.
    2.1 Explaining lines of codes – explaining what the codes in the pictures mean.
    2.2 Preparing to write our first program – most likely will be a calculator program.
    3.0 Writing our first program – images of the program and explaining.
    3.1 Reviewing the program – going over the lines or the important lines of codes and explaining it.
    3.2 What we learnt from the program – what did we learn by understanding what the code of the program means.
    4.0 Explaining [TBD but a part of the language] Ex. Methods
    4.1 Explaining [TBD but a part of the language] Ex. Loops
    4.2 Explaining [TBD but a part of the language] Ex. Objects
    5.0 Using the explained 4.0 in action – use code based on 4.0
    5.1 Using the explained 4.1 in action – use code based on 4.1
    5.2 Using the explained 4.2 in action – use code based on 4.2
    6.0 Making a program that relies on everything we learnt – last program of the manual
    6.1 Reviewing the program – explaining the last program
    7.0 Conclusion

  2. From: Jared Williams
    To: Prof. Jason Ellis
    Date: November 3, 2021
    Subject: Other Sections for Instruction Manual

    A. Introduction
    1. Intended Audience
    2. Scope – What we aim to do
    3. Motivation – Purpose behind this manual
    4. Build type – What kind of machine are you aiming to make?
    5. Budgeting – Setting an upper and lower limit spending wise
    6. Part selection – Where to find parts and what to watch out for
    B. Parts 101
    1. CPU – Central Processing Unit
    2. GPU – Graphics Processing Unit
    3. RAM – Random Access Memory
    4. Power Supply
    5. Storage Drives – Hard Disk Drive/Solid State Drive
    6. Case
    7. Cooling – Water/Air cooling
    8. Accessories
    C. Preparation
    1. Safety and Disclaimers
    2. Recommended Tools
    3. Downloading OS to removable drive
    4. General tips
    D. Assembly
    1. Step 1 – Seating CPU
    2. Step 2 – Attaching CPU cooler
    3. Step 3 – Seating RAM
    4. Step 4 – Inserting motherboard into case
    5. Step 5 – Seating GPU
    6. Step 6 – Installing Hard Drive
    7. Step 7 – Power supply
    8. Step 8 – Connecting cables to motherboard
    9. Step 9 – Cable Management
    10. Step 10 – POST (Power On Self-Test)
    E. OS Installation
    1. Step 1 – Entering BIOS
    2. Step 2 – Modifying Settings
    3. Step 3 – Selecting removable drive to boot
    4. Step 4 – Installing the OS to storage medium
    5. Step 5- First time setup
    F. Troubleshooting
    G. Glossary
    H. References

  3. To: Prof. Jason Ellis
    From: Rosario Garcia
    Date: Nov 3, 2021
    Subject: Draft about the computer manual
    1.0 Introduction -basic information
    1.1 The purpose of the summary is to provide useful information for the
    1.2 The audience is to people going buy specific laptop or pc for needs
    1.3 The area choosing specific laptop and its software
    1.4 Choosing a certain brand pc/laptop and software and programs
    1.5 The convention does the job and fit the user needs and requirements
    1.6 The motivated is continue understanding and learning that there may be some requirement doesn’t meet but can improve.
    1.7 Safe and Disclaimer always backup the data in hard drive or cd if the laptop/pc not functioning
    2.0 Research about the specific laptop/pc, also have budget in mind
    2.1 The laptop / pc specs fit with your needs
    2.2 Description of the Equipment’s Parts
    3.0 Budget, hard drive or cd, laptop/pc
    3.1 The for the laptop or computer usage for example some laptop built for gaming, coding, businesses, work, education, or simple task use like browsing the
    3.2 Check the items require in stock and the items to setup the laptop or pc ready to use
    3.3 laptop, usb ,cd, charger, if it pc setup then monitors, keyboard ,mouse, portable hard drive, desk
    4.0 Start up the laptop and follow the manual or building the pc by following the instruction
    4.1 startup laptop / pc and start installation
    4.1.1 correct charger
    4.1.2 check the installation run well
    4.1.3 Everything is work properly and able setup the basic need the laptop or pc
    5.0 run troubleshot run into issue
    6.0 re-Check the manual everything perfectly running
    7.0 Glossary

  4. To: Prof. Ellis
    From: Muztahid Sakif
    Date: Nov. 4, 2021
    Subject: Other Sections for Instruction Manual

    1.0 Introduction- Give brief overview of Cisco Packet Tracer
    1.1 Purpose- Explain the purpose of the instruction manual
    1.2 Intended Audience- Explain who can benefit from the instruction manuel
    1.3 Devices- Explain all the devices needed to build the network (including pictures)
    1.4 Wires- Explain the different wires necessary for this manual (include pictures
    1.5 Download- Briefly talk about the download process
    1.6 Features- Discuss the different features in Cisco to achieve network creation
    1.7 Order- Explain the order of the devices
    2.0 Configuration- Explain and demonstrate how to configure the devices
    2.1 Ping- Explain how to ping devices to check how they can communicate
    2.2 Assigning- Explain how to assign ip address and default gateway to end user and routers
    3.0 End user- Explain how to use command prompt using the pc
    3.1 Command Line Interface- Discuss CLI and its purpose
    3.2 Discuss real life usage of networks

  5. To: Prof. Ellis
    From: Gani Graceni
    Date: November 11, 2021
    Subject: More of the list of instructions Manual

    The purpose of this draft is to show the process of the instructions manual on how to program a PIC microcontroller. Being that PIC microcontrollers are extremely useful tools for use and development in many electronic and computer applications any electrical or computer science engineer should know the basic steps how to program a PIC microcontroller.
    This set of instructions would come handy to a hardware and software engineer at the same time. For this list of instructions Microchip data sheets will be used to get the specs for programming PIC16 Series only.

    1. Construct the Hardware ( Basic set up to light an LED or turn on a Fan or DC motor)
    a) Power up the chip using VDD Positive voltage and VSS ( Ground)
    b) Connect PIN 2, PIN 3, PIN 4 and PIN 5 for COM with the programmer
    c) Connect OUTPUT PIN A0 to an LED. ( optional )
    2. Find and install the Software in your PC or MAC
    a) https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide
    b) Open MPLAB X software
    3. Create a new project file
    a) File / New / Project
    4. Build parameters in the software
    a) Manage configurations
    b) Select proper PIC model
    c) Select proper programmer
    d) Select proper compiler
    e) Select apply
    5. Configure the specific Microchip PIC16
    a) Select the bit configuration of the IC
    6. Configure the bits
    a) Change the defaults or click Ok
    7. Configure the oscillator and watchdog timer
    a) Select the frequency of the Oscillator
    b) Set up the watchdog timer for running the code
    8. Set up the Wait(milliseconds) timer
    a) Set up a time delay in milliseconds click Ok
    9. Write and modify the code
    a) Debug the code using “Debug” feature on the toolbar.
    b) Fix the bugs or software errors.
    10. Select the programmer
    a) Select PM3 Programmer
    b) Click Ok
    11. Configure the programmer
    a) Make sure the configuration is successful
    12. Build the project
    a) Click build
    13. Make and download from programmer to device
    a) Press “Make and download” on the MPLAB X Toolbar
    14. Check is the program finished “Successful”
    15. Double check if the program checksum is equal to the device checksum

  6. To: Prof. Jason Ellis
    From: Edwin Baez
    Date: 11/05/2021
    Subject: Other Sections For Instruction Manual

    The purpose of this memo is to show my draft on my list of processes to follow if one wants to build their own computer.

    1.1 Introduction- Introduces the different architectures
    1.2 Intel
    1.3 AMD
    1.4 Deciding on CPU Architecture
    2.0 Budgeting Of Parts – Setting the budget for the parts going into the machine
    3.0 Selection of Parts- Selecting the parts
    3.1 Motherboard
    3.2 Case
    3.3 CPU
    3.4 GPU
    3.5 PSU
    3.6 RAM
    3.7 Fans
    3.8 Personal Customization
    4.0 Parts compatibility check- Checking if every part is compatible with each other
    5.0 OS Preparation – Preparing the USB to be a bootable drive
    5.1 Acquire USB FlashDrive
    5.2 Windows Media Creation Tool
    5.3 Transferring to USB
    6.0 Workspace Preparation- Preparing your work area for safe PC building
    6.1 Clean environment
    6.2 Ground yourself
    6.3 Screws placement
    7.0 Case Setup- Preparing the case to be worked on
    7.1 Unboxing Case
    7.2 Fragile Case Parts
    7.3 Case layout
    8.0 Motherboard setup- Steps to prepare the Motherboard
    8.1 Installing CPU
    8.2 Installing CPU Cooler
    8.3 Seating RAM
    8.4 Installing Fan headers
    8.5 Installing NVME (optional)
    8.6 Installing SSD/HDD
    9.0 GPU installment- Steps to install the GPU into the motherboard
    9.1 Unscrewing case guard
    9.2 Clearing GPU slot
    9.3 Inserting GPU
    10.0 Power Supply Installment- Steps to install the PSU into the case and connect cables to Motherboard
    10.1 Unscrewing Case screws
    10.2 Inserting PSU
    10.3 Connecting Cables
    11.0 Cable Management- Cleaning up the cables for a more organized experience
    12.0 Booting into PC for first time- Taking the first steps into setting up our PC
    12.1 Loading into BIOS
    12.2 Optimizing Performance
    12.3 Setting USB to as boot drive
    13.0 Installing OS- Installing the Operating System (OS) and steps after installment
    13.1 Booting into OS with USB
    13.2 OS Setup Process
    13.3 Clean install of OS
    13.4 Connect to Internet
    13.5 Update OS to latest version
    13.6 Partition SSD/HDD
    14.0 Installing drivers- crucial step for after PC is setup
    14.1 Search up Motherboard manufacturer website
    14.2 Download latest drives available for Motherboard
    14.3 Search Up GPU manufacturer
    14.4 Download latest GPU drivers
    14.5 Restart
    15.0 Troubleshooting- Troubleshoot common problems with certain parts
    15.1 Motherboard
    15.2 GPU
    15.3 Installing OS
    15.4 BIOS
    15.5 Connecting to Internet
    15.6 Disk Partitioning
    15.7 RAM
    16.0 Glossary
    17.0 Reference List

  7. To: Prof. Jason Ellis
    From: Olamide Yomi
    Date: 11/05/2021
    Subject: Instruction Manual

    The purpose of this memo is to get general basics about HTML CSS and JavaScript and use it to build a simple web application.

    1.0 Introduction to HTML and HTML editors/basic
    1.1 Installing of Visual Studio Code (https://code.visualstudio.com/download)
    1.2 Different Element and basic implementation of HTML
    1.3 HTML Class and ID
    1.3.1 Using The class Attribute
    1.4 HTML Form and Graphics
    1.4.1 HTML Form Elements
    1.4.2 HTML Form Attributes
    1.5 HTML Media and APIs

    2.0 Introduction to CSS
    2.1 CSS Syntax and selector
    2.2 Adding color, backgrounds and borders
    2.3 Using padding, height/width, and important CSS function functions.
    2.4 Advanced CSS coding.
    3.0 Introduction to JavaScript
    3.1 Implementation JavaScript to HTML

    3.2 JavaScript Variable
    3.3 JavaScript Functions
    3.4 JavaScript Let and Const

    4.0 Creating Facebook replica
    4.1 Using HTML
    4.1.1 Using HTML elements (, , , and ):
    4.1.2 Adding classes and ID
    4.2 Adding CSS from style and design
    4.2.1 Adding color, backgrounds and borders
    4.2.2 Using padding, height/width, and important CSS function functions.
    5.3 Adding JavaScript for functioning
    5.3.1 Using Var, Function QuerySelector and other simple java implentation

    5.0 Creating YouTube replica
    5.1 Using HTML
    5.1.1 Using HTML elements (, , , and ):
    5.1.2 Adding classes and ID
    5.2 Adding CSS from style and design
    5.2.1 Adding color, backgrounds and borders
    5.2.2 Using padding, height/width, and important CSS function functions.
    5.3 Adding JavaScript for functioning
    5.3.1 Using Var, Function QuerySelector and other simple java implentation

  8. To: Prof. Ellis
    From: Victor Li
    Date: Nov 6, 2021
    Subject: Draft about Python Manual

    The purpose of this memo is to use Python programming language to create a website.

    1.0 Click on Safari (Mac) or Google Chrome (Mac and Windows)

    1.1 Click Search Bar then type http://www.python.org

    1.2 Click Download tab and then proceed to download Python

    1.3 Click on the “Python Installer” tab on the laptop

    1.4 Click “Continue and then finish installing Python

    1.5 Open Python software on your laptop or desktop

    2.0 When you enter Python you can start typing your code for your website

    2.1 Make sure that the code can run smoothly

    2.2 If code is wrong, try to troubleshoot it and rerun the code until it is correct

    2.3 When you finish the code, exit the app and save the code

    2.5 Enjoy using your new created website on the internet.

    3.0 Glossary

  9. TO: Prof. Ellis
    FROM: Alex Cheung
    DATE: Nov., 2021
    SUBJECT: Other Sections for Instruction Manual

    The purpose of this memo is to show the layout of the instruction manual.

    1.0 Introduction
    1.1 Purpose of the manual
    1.2 Intended Audience
    1.3 Safety and Disclaimers

    2.0 Software / Tools / Files needed
    2.1 Explaining what each Software / Tools / Files is going to be used for

    3.0 Instructions
    3.1 First, we need to install a virtual machine. We are going to be using VirtualBox (https://www.virtualbox.org/).
    3.1.1 Navigate to the download page.
    3.1.2 Download the VirtualBox version compatible with your system.
    3.1.3 After download is complete, run the install and follow the instructions.
    3.2 Second, we need to get our Ubuntu Desktop iso (https://ubuntu.com/).
    3.2.1 Navigate to the download page for Ubuntu Desktop. Download should start automatically.
    3.2.2 Keep iso in an easily accessible directory.
    3.3 Third, we are going to be setting up the virtual machine.
    3.3.1 Open VirtualBox.
    3.3.2 Click the “New” option to make a new virtual machine.
    3.3.3 Give the virtual machine a name, the directory you want it to be located, the OS type (Linux), and the OS version (Ubuntu). Click “Next”.
    3.3.4 Choose how much ram to allocate to the virtual machine. Click “Next”.
    3.3.5 Choose “Create a virtual hard disk now”. Click “Next”.
    3.3.6 Choose “VDI”. Click “Next”.
    3.3.7 Choose a storage option that is right for you. Click “Next”.
    3.3.8 Set the size limit for the virtual machine. Click “Next”.
    3.4 Fourth, we are now going to install the Ubuntu Desktop OS.
    3.4.1 Click on the just created virtual machine.
    3.4.2 Select the Ubuntu Desktop iso that we downloaded earlier.
    3.4.3 Follow the install instructions provided by the installer.

    4.0 Troubleshooting

    5.0 Glossary

    6.0 Reference List

  10. To: Prof. Ellis
    From: Mamadou Sakho
    Date: Nov 3, 2021
    Subject: Other section for instruction manual

    1.0 Introduction
    1.1 Purpose: tips on how to make an audio amplifier
    1.2 Audience: Electrical students and whoever wants it.
    1.3 Scope: steps to achieve the goal
    1.4 Organization Descriptions: step by step from design to wiring to assembly
    1.5 Conventions:
    1.6 Motivation:
    1.7 Safety and Disclaimers:
    2.0 Description of the Equipment: the main equipment needed is the soldering material
    2.1 Illustration of the Equipment: the soldering iron has a tool that can help correct errors during soldering
    2.2 Description of the equipment’s parts: the soldering iron comes with 5 multiple soldering tips, tin wire tube, soldering iron stand, soldering iron, desoldering pump, tweezers, wire stripper cutter, and 2 electronic wires.
    3.0 List of materials and equipments: PCB board, soldering iron kit, wires, power supply(12V), banana jack, potentiometer
    3.1 Illustration of the Parts Needed to carry out the instruction: After buying the tools and parts, design the layout and transfer it into the PCB board.
    3.3 Table: the attached table will briefly explain each part used in this project
    4.0 Direction: explained step by step from scratch to the complete project
    4.1 How to put parts together without mistake
    4.1.1 step 1: the first step is to choose the amplifier and design the layout which will be transferred into PCB
    4.1.2 step 2: put the PCB with the layout in it into the solution to dissolve the copper
    4.1.3 step 3: make holes on the board for soldering
    5.0 Troubleshooting: mistakes will happen, therefore, troubleshoot using a multimeter
    6.0 Glossary: will show the project in detail
    7.0 Reference list

  11. TO Prof. Jason Ellis
    FROM: Pape Diop
    DATE 11/13/2021
    SUBJECT: Other Section for Instruction Manual

    The purpose of this memo is to provide a few steps on how to find data using Python and the command line.

    1.0 Installing Python
    – Using The Command-Line to install Python latest version
    – Basics of Python commands

    2.0 Installing Visual Studio Code Application
    – Downloading & installing Visual Studio latest version
    – Creating a folder for the project
    – Creating a file in a project
    – Using Python in Visual studio

    3.0 Installing Mango Database Enterprise
    – Downloading and installing Mango Database latest version
    – Moving Mongo folder to Developer folder
    – Creating a Data folder
    – Updating the “bash_profile” folder

    4.0 Downloading the stock data file
    – Storing the stock file in the database folder
    – Testing Stock database
    – Running Mongo command to start the shell online.

    5.0 Finding data from the stock database
    – Connect Mongo DB to Visual Studio using Python
    – Writing simple Python code to find any data in the stock data
    – Running the code

  12. To: Prof. Jason Ellis
    From: Ducquon Hinds
    Date: December 14, 2021
    Subject: Other Sections for Instruction Manual

    – How to create training manual
    – Steps to create employee training manual
    Step 1: Identify the objective of employee training manual
    Step 2: Collaborate to create employee training manual
    Step 3: Understand your audience
    Step 4: Set the milestone and deadlines
    Step 5: Analyze what should be included
    Step 6: Use the right tool
    Step 7: Get the feedback and improve
    Summing It

Leave a Reply