|
0
|
004-Module-1-Wr327-Sp2018-INSTRUCTION-MANUAL-template-examples-recommendations
|
|
1
|
Fri06Apr2018—Module 1, Week 1, Day 3
|
|
2
|
Using the template, examples and recommendations provided below, you should be able today to create your own Instruction Manual. NOTE: Your completed Instruction Manual assignment will be worth 100 points and is due Sun15Apr at 11:59 PM—upload your file (doc,docx,pdf) to Canvas.
|
|
3
|
Please see the following Canvas file for an example of a completed Instruction Manual: “007-Module-1-Wr327-W2018-COMPLETE-EXAMPLE-Instruction-Manual.”
|
|
4
|
|
A Proposed App: A Rainwater Resource Tour of OSU
--Instructions for the App Developers
Submitted to Mr. Jacky Chan, Project Manager, OSU Special Projects Office
Submitted by Glen Agee
Submitted April 15, 2018
Wr 327 Section# [ABC], spring term 2018
|
|
Recommendation #1: Adapt the title half-page information above to your project—lease insert your name and title.
Also, “ABC” is a placeholder for the section number for your Wr 327 class.
|
|
Note to the Developers:
The Special Projects Office at Oregon State University (OSU), as a part of its annual promotion of student-designed projects, has issued an RFP (Request for Proposals) for 5-page, 500-word descriptions of OSU-based software applications. Proposed “apps” must benefit OSU students, and may either be a new design or an improvement to existing software. All proposals must be submitted by April 15, 2018, and these will be reviewed by Mr. Jacky Chan and the staff at the OSU Special Projects Office. Designs will be selected for further development based on their potential usefulness to OSU Students—with the design authors notified by June 15, 2018.
|
|
Recommendation #2: Please use verbatim the “Note to the Developers” text immediately above.
|
|
Recommendation #3: The Preface is a full “7Ws” introductory paragraph [approximately 250 words] that names and describes your app. 1) Introduce yourself, providing your name and your relevant OSU interests. 2) Describe whether your proposed app is new, leveraged, or an add-on—and state its proposed compatibility with mobile devices. 3) State whether (in your estimation) the app would be inexpensive or expensive to develop/maintain—and please include a suggestion as to the location where the app could be downloaded. 4) Next, provide details regarding the usefulness of your proposed app. 5) Based on your research queries using the OSU Portal, provide verifiable OSU background information that supports the development of your app. 6) Describe when (under what circumstances) the app would be useful to OSU students. 7) Finally, state the following in your own words: “If this proposed app is selected by the OSU Special Projects Office for development, [XYZ] agrees to abide by the contract terms and to consult with the developers.”
|
|
Preface: Glen Agee—currently a sophomore majoring in Environmental Sciences at OSU—is proposing to Mr. Jacky Chan that the university develop a new, inexpensive software app that could be downloaded to either Android or Apple iOS mobile devices. This new app—A Rainwater Resource Tour of Oregon State University—is estimated to be inexpensive to program and easy to maintain. It is recommended that this new app be available for download from a link on the web site for OSU-supported software: http://oregonstate.edu/helpdocs/osu-applications/citrix-apps . The “Rainwater Tour” should be the first in a planned series of apps that complement sustainability studies at OSU—ranked for 2017 by the Sierra Club as 20th-out-of-227 US universities committed to sustainability. OSU’s Sustainability Office currently provides a “Rainwater Resource Guide” brochure that includes a map of locations where rainwater resources can be found on the Corvallis campus: Sewer Access structures, Rain Gardens, Rain Collection and Bioswale locations, Permeable Pavement areas, and Green Roof installations. However, this OSU brochure does not include details per location regarding design intent and capacity, pollution reduction efficiency, soil structures, or plant species used in the installation. Details such as these would greatly benefit Environmental Science studies at OSU and should be included in the proposed app. If this proposed app is selected by the OSU Special Projects Office for development, Glen Agee agrees to abide by the contract terms and to consult with the developers.
|
|
|
5
|
Recommendation #4: Pages 2 and 3 of your Instruction Manual must describe the GUI (Graphic User Interface) for your proposed app. You should provide a picture/photo/graphic of three levels for your app by providing “3 screens.” Each screen depicted should include a label/caption. Hand drawn sketches will do—or a combination of images and words, as shown below. Description of the GUI also includes an Instructional Overview, six repetitive instructions, and a Results summary. See the example below.
|
|
6
|
|
Instructional Overview of the GUI (Graphic User Interface): The Rainwater Tour app should capture all the information found in OSU’s current Rainwater Resource Guide brochure (updated 2017)—found at this URL: http://fa.oregonstate.edu/sites/fa.oregonstate.edu/files/sustainability/docs/rainwater_brochure_web_small.pdf
This tri-fold brochure is currently available online as a pdf file and includes a campus map with the location of 27 resources in six categories. Ultimately, the Rainwater Tour app should link to web sites with more information.
|
|
|
7
|
|
OSU Rainwater Resource Tour App
|
OSU Pride Center Rainwater Tank
|
Rain collection specifications
|
|
|
|
Rainwater collection tank at the OSU Pride Center (1553 SW A Ave, Corvallis, OR 97333):
·
Design Intent
·
Tank materials
·
Tank capacity
·
Impact on local environment
|
|
|
The rainwater collection tank at the OSU Pride Center (1553 SW A Ave, Corvallis, OR 97333) was designed by an engineering student using an old composting bin. Rainwater is used for watering plants around the Pride Center’s permaculture garden.
See specifications.
|
|
|
Expand the map to follow links
|
Resource overviews with spec links
|
Links to Online Detailed Info
|
|
Home Page design
|
Second Level Screen design
|
Third level Screen design
|
|
|
8
|
NOTE: When we draft the 2nd half of your Instruction Manual (Instructions 7-12) assignment on Thu18Jan, you will be asked to provide a high-level description of the data that your app would provide to the user.
|
|
9
|
GUI Instruction #1: The Home Page design of the Rainwater Tour app should be an expandable, navigable version of the campus map that is found in OSU’s current Rainwater Resource Guide pdf file. This touchscreen should have “dot” links to a second-level description of individual resources. Across the top of the touchscreen should be the title: “OSU Rainwater Resource Tour App.”
|
|
10
|
GUI Instruction #2: The Home Page design of the Rainwater Tour app should have the following vivid color coding :
· Grey location dots identifying the location of Sewer Access structures
· Blue location dots identifying the location for Rain Gardens
· Red location dots identifying the location for Rain Collection stations
· Orange location dots identifying the location of Bioswales
· Yellow location dots identifying the location of Permeable Pavement areas
· Green location dots identifying the location of Green Roof installations
|
|
11
|
GUI Instruction #3: The Second Level Screen design of the Rainwater Tour app should consist of a color photograph of a Rainwater Resource at the top of the screen. Beneath the photo should be a short summary description of the Rainwater Resource. At the bottom of the screen should be an obvious link to a third level screen that will give users options for exploring detailed information: “See specifications.”
|
|
12
|
GUI Instruction #4: The Second Level Screen design of the Rainwater Tour app should provide overview information related to each of the specific rainwater resource found on the OSU campus. This proposed app would provide an overview of all 27 resources currently found on OSU’s Rainwater Resource Guide” brochure. See an example depicted above.
|
|
13
|
GUI Instruction #5: The Third Level Screen design of the Rainwater Tour app should include the following content: Text at the top of the screen lets the user know what resource they are exploring; this is followed by a categorization of available information (links) regarding the resource and found on the resource owner’s website.
|
|
14
|
GUI Instruction #6: The Third Level Screen design of the Rainwater Tour app should include links to the resource owner’s website. Categories of information (provided in instructions 7-12, below) should be blue italics, versus the black-text resource description.
|
|
15
|
Results Summary of the GUI: Users should be able to rapidly navigate from the home page to the second-level overviews to the third-level links to detailed information on the resource owner’s website. Navigation includes an expandable, searchable map of the OSU campus—similar navigation to that provided by Google maps. “Back” navigation should be provided at levels two and three.
|
|
16
|
006-Module-1-Wr327-W2018-NST-MAN-pt2-Writing-Prompt
Thu18Jan2018—Module 1, Week 2, Day 2
|
|
17
|
Using the template, examples and recommendations provided below, you should be able today to create your own Instruction Manual. NOTE: Your completed Instruction Manual assignment will be worth 100 points and is due Sun21Jan at 11:59 PM—upload your file (doc,docx,pdf) to Canvas.
|
|
18
|
Please see the following Canvas file for an example of a completed Instruction Manual: “007-Module-1-Wr327-W2018-COMPLETE-EXAMPLE-Instruction-Manual.”
|
|
19
|
Recommendation #5: Pages 4 and 5 of your Instruction Manual must describe the data/info that the developers have to include in your app—the developers make sure your app requirements are met during integration testing. Your task is to create six instructions (7-through-12) that describe what the developers must test for, as well as an overview/intro for 7-through-12 and a results summary describing usability—see the examples below.
|
|
20
|
Recommendation #6: Start writing and describe the data/info that the users expect to see when using your app. Describe the following: a) where the developers should start and what they should leverage/re-use; b) what to add; c) what to change; d) what not to forget—some repetition is okay; and e) provide examples. Finally, arrange your instructions according to the three levels/screens that are a (required) part of your design—and then add the overview summary and the results (usability).
|
|
21
|
|
Overview for Developers regarding integration testing: To facilitate online tours of the current 27 Rainwater Resources on the OSU-Corvallis Campus, the proposed app should “leverage” (re-use) Oregon State’s current, online interactive campus map—which has the following features:
· Search for a building
· Highlight Multiple buildings
· View a map to find your way to class and any events
· Drag to pan
· Zoom in and out
· Experience a choice of view
· And many other interactive benefits much like google maps
The features of this map are described at this URL: http://oregonstate.edu/cws/campus-map
The map itself can be found at this URL: http://oregonstate.edu/campusmap
|
|
Instruction #7—Integration Testing of the Home Page: The map on the app’s home page should allow the user to tap/select any one of the six categories of Rainwater Resources, as described in the GUI. Tap/selecting the “Rainwater Collection” category, for example, would then pinpoint all four Rainwater Collection sites on the OSU Campus map.
|
|
Instruction #8—Integration Testing of the Home Page: Users of the app should be able to double-tap to zoom in on any one of the pinpointed sites. A tap/hold on the site of interest would take the user to a second-level screen with a description of the site.
|
|
Instruction #9—Integration Testing of the Second-Level pages: The app’s second-level screens all include color photos of individual installations. Additionally, the app’s second-level screens include a brief description of the site, including the street address. The final element of the second-level screen is a link to a third-level screen: “See specifications.”
|
|
Instruction #10—Integration Testing of the Second-Level pages: Whatever site information that may be missing from the current OSU campus map, must be added to make the app complete. For example, the Oak Creek Center for Urban Horticulture, 844 SW 35th Street, CORVALLIS, OR 97331, has four Rainwater Resources: Rain Gardens, Rain Collection, Permeable Pavement, and Green Roofs. However, the OSU Campus Map does not call out this location—other than identifying four buildings with obscure names like “Nursery Storage.”
|
|
Instruction #11—Integration Testing of the Third-Level pages: At the top of the level-three screens the name/address of the rainwater resource site is repeated. (See GUI description.)
|
|
Instruction #12—Integration Testing of the Third-Level pages: The bottom half of the level-three screens includes categories of detailed information about the site—the categories are links to the resource owner’s web site. The categories of available detailed information should be supplied by the resource owners. (See GUI description.)
|
|
Results Summary for Developers regarding integration testing: App users should have the ability to navigate back to the previous level when at level two, three, or from the resource owner’s web site.
----When opening the home page, app users should be able to view all 27 rainwater resources on the OSU campus—these 27 resources should be color-coded per the GUI description.
----A legend would also allow users to see categories individually—tapping the red Rainwater Collection label on the home page legend, for example, would then highlight only the four locations for Rainwater Collection stations on the OSU campus.
----Using a tap/hold selection, users would then be able to see (one site at a time) rainwater collection information for the following sites:
· Oak Creek Center for Urban Horticulture, 844 SW 35th STREET ,CORVALLIS, OR 97331
· Energy Center, 3452 SW JEFFERSON WAY, CORVALLIS, OR 97331
· Kelley Engineering Center, 110 SW PARK TERRACE, CORVALLIS, OR 97331
· Pride Center, 1553 SW A AVE, CORVALLIS, OR 97333
|
|
|
22
|
Your completed Instruction Manual assignment will be worth 100 points and is due Sun15Apr at 11:59 PM—upload your file (doc,docx,pdf) to Canvas.
|