Introduction: Uploading Your Group's Technical Documentation Project

Picture of Uploading Your Group's Technical Documentation Project

This Instructable is designed for the students of ENGL 313. It offers __ pointers for uploading content to Instructables.com, which is required of students for writing project 2.

To upload your project for usability testing and for the showcase, you must create an Instructables account.

Visit www.instructables.com. In the upper right corner of the webpage, you will see Create an Account. Click this link and complete the registration process. 


Step 1: Get Organized

Type your instructions, broken into the relevant steps, in Microsoft Word. 

The first "step" includes an intro "step," so you enter content on two steps, but they are presented in the final product as one page. You get two "main" images, one that should represent the title of your project and one that represents the action of step one.

Step 2: Upload Images

Picture of Upload Images

Upload all of your screen shots at once. It will streamline the editing process later. Name screenshots the same as the step title where you plan to use it. My image for this step, for example, is titled Upload Images. 

You get one "main" image per step, which can be embedded in text. Think carefully about how you want to use it. The other images are smaller and line up at the bottom of your text. The smaller images could be a series of screenshots documenting several actions included in the step. 

To highlight information in your image by clicking on the image and dragging a box. A text box will pop up and you can enter text if you like.

Step 3: Be Consistent in Language

Picture of Be Consistent in Language

Notice my title for this step. The "B" is capitalized but nothing else is. Click back to step one. What does my title look like? You want all of your step titles to have a consistent from. Start all your steps with a verb or a noun, but don't switch back and forth. Likewise for capitalization; I should have titled this step Be Consistent in Language. If you choose to use title case, the only words you do not make capital are articles.

Comments

kelseymh (author)2010-09-18

On step 2, note that the other images can be equally active and complex. Users can click on the thumbnails, and I'bles will show the image in full size, with any attached image notes.

kelseymh (author)2010-09-18

On Step 1, you're recommending that your students use Word. There have been some problems on the site with copying text directly from Word, because the latter embeds a whole lot of invisible cruft which confuses the I'bles text editor.

Generally, it's better to either write directly into a simpler editor (such as Notepad), or take the Word text, paste it into Notepad, and then recopy from there into I'bles.

Yes, it's a pain, but having weird nonsense show up in the step "hover text" is a bigger pain.

Besides that, it sounds like we can look forward to a number of excellent projects in the next few weeks! Welcome to Instructables!

About This Instructable

400views

2favorites

License:

More by ENGL 313:Uploading Your Group's Technical Documentation Project
Add instructable to: