TalentNation.net Blog

Manuals and Long Documents

2009-03-09T18:51:00.001-07:00

In cases where you want to do the documentation yourself because you want it done right or because no one else has ever done it before, you don't want to invest yet more resources into the crucial, although ancillary matter of documentation.

Ideally, you will involve the writers or illustrators early on in the development process of the software, hardware, or procedures. In the real world, however, the documentation often comes into play after the fact. Not to worry.

TalentNation.net works with your technicians, analysts, code developers, engineers, with minimal disruption, doing precisely as little or as much as is essential, realizing that the role of the documentation is subordinate to that of the subject matter and, thus, understanding the priorities of your organization.

Long documents and manuals should stand for as long as does the subject matter that they address, making a lasting and positive impression every that anyone picks them up.

Illustrated Procedures

2009-03-09T17:38:00.000-07:00

Pictures are one thing, well-done pictures (line art, solid-model renderings, photographs, more) are another thing, but best of all are procedures that integrate narrative (instructions) with well-done pictures.

Think about how you speak when giving instructions. Whether you realize doing so or not, you speak in the imperative mood, saying, for example, "tweak the widget," giving a polite order. Conversely, poorly written procedures may meander in and out of the declarative mood without good reason. The preceding reads much less forcefully in the declarative: "the widget is tweaked." Plus, the declarative mood construction introduces the passive voice, cardinal sin against clear, concise writing.

You will not have to worry about such issues with TalentNation.net. We will take care of the artwork (of your choice), capturing and validating the correctness of the content, integrating both in minimally-sized files, archiving it all for editing or distribution purposes or subsequent revision. We think fast on our feet too, because the topic of conversation (that which the documentation addresses) may change midstream, because reality happens fast oftentimes. Supporting hectec schedules or other project constraints is normal operating procedure.

Getting Started Documents

2009-03-09T17:18:00.000-07:00

Your subject matter expert will speak through the deliverable (mostly pictures), gently guiding new users through only the most essential first steps and doing so with the big-picture assurance that only an expert can provide. Tabloid-sized layouts fold up handily and give plenty of room for illustrations (line drawings, photographs, diagrams, clip art), white space and text. Best of all is the correctness of the content, starting with the writing (English, Spanish, French, Portuguese, German, Chinese, or any combination thereof) through to the integration with the artwork. If tabloid-size is bigger than your needs require, TalentNation.net does layouts ranging in size down to postcards. Click to contact TalentNation.net.

Style Guides

2008-12-07T06:10:00.001-08:00

Word choice, white space, fonts, exacting punctuation and grammar, capitalization--such details determine professionalism if handled properly or smack of hack amateurism if not. Rely on TalentNation.net to give your documentation the same calculated and polished look and feel as that you find in publications by Microsoft, IBM, or the Economist. How? We follow the book, Microsoft, IBM, and the Economist's styles to be precise.

Your documentation will look like something published by the big boys. We've worked with the big boys, so we know. The details carry much weight with regard to delivering consistent look and feel. The crispest documentation is crisp precisely because the details are consistent. This is true with IBM, Halliburton, Hamilton Sunstrand, Exxon/Mobil, and more, all of whem we've worked with, and it will be true with your documentation too.