The following Weblinks will take you to sites that provide useful advice and interesting
examples. Please note that, at any time, a site might change or disappear. (Pay particular attention
to the "hot topics" identified by hot orange introductions.) If you find other useful sites, please email their
URLs to me at dklepp@shaw.ca.
All links will open in a new browser window.
Chapter 1
These sites discuss the nature of technical writing and technical writing careers and give job listings for technical writers, collaborative writing techniques, and hints for effective technical documents.
www.stcloudstate.edu/~scogdill/collaboration/biblio.html
www.jeanweber.com/about/edrole.htm
This site provides Internet resources for technical communicators:
www.soltys.ca/techcomm.html
For information about VPNs, see the Virtual private Network Consortium website:
www.vpnc.org
This selection describes the role of the technical editor within the technical writing team.
www.jeanweber.com/about/edrole.htm
This site opens to an overview and reviews of resources, software, training environments, collaboration/conferencing software, and tools. The section on blogs is particularly useful.
mason.gmu.edu/~montecin/platforms.htm
>> Back to Top
Chapter 2
For useful discussions of audience analysis, visit:
www.io.com/~hcexres/tcm1603/acchtml/aud.html
owl.english.purdue.edu/workshops/hypertext/reportW/audience.html
For advice on cross-cultural studies and intercultural communication, see:
www.immi.se/intercultural/
www.stephweb.com/forum/index.htm
www.interculturalrelations.com/
Here are four case studies examining issues in intercultural technical communications, and also some links to discussion groups:
www.world-ready.com/cases/index.htm
Asterisks.com. provides a concise set of suggestions for maintaining clarity when writing in English for a foreign readership.
asterisks.com/tut0298.html
I recommend this online tutorial for exploring the similiarities and differences in cultures in the global village:
www.bena.com/ewinters/xculture.html
The Society for Technical Communication (STC) has compiled this collection of resources regarding internationalization, localization, translation, cross-cultural communication, and technical communication worldwide. Projects include a bibliography and "kits" of articles on specific topics.
www.stcsig.org/itc/
>> Back to Top
Chapter 3
The Clarkson University Writing Center has links to tips for writing efficiently and effectively; try the "General Writing Skills" and the suggestions for writing technical documents.
www.clarkson.edu/~wcenter/skills.html
www.clarkson.edu/~wcenter/wac.html
Colorado State University's writing site explores different aspects of writing and different processes that can be applied in differing situations.
writing.colostate.edu/references/processes.cfm
Here are some links to interesting material on single sourcing:
www.stc.org/intercom/PDFs/2002/200201_15-17.pdf
www.soltys.ca/techcomm/articles/the_joy_of_single-sourcing.html
www.stcsig.org/ss/articles062002/6_02_ss_Tools_article.htm
stcrmc.org/technicalities/april_may_2003/feature5.htm
www.techwr-l.com/techwhirl/magazine/technical/singlesourcing.html
>> Back to Top
Chapter 4
These sites discuss persuasive techniques applied to a variety of genres and media:
www.webpagecontent.com/arc_archive/42/5/
www.editorialservice.com/11ways.html
www.superwriter.com/persuasi.htm
>> Back to Top
Chapter 5
This Web site covers a wide range of ethics issues for technical people trying to cope with difficult situations. In particular, see the "Moral Exemplars" and "Engineering Practice" secondary sites.
onlineethics.org
The following sites present Canadian engineering codes of ethics:
Canadian Council of Professional Engineers
www.ccpe.ca/e/guide_guidelines.cfm
Professional engineers of Ontario
www.peo.on.ca/publications/code_of_ethics.html
Canadian Society for Chemical Engineering
www.chemeng.ca/about/mission/cic_ethics__e.htm
Institute of Electrical and Electronic Engineers (international)
www.ieee.org/
(look for the IEEE Code of Ethics under the "About IEEE" menu)
This U.S. site chronicles the investigation of Monsanto's chemical pollution of Anniston, Alabama. The site includes confidential internal Monsanto memos and technical documents that became public because of court cases against Monsanto.
www.chemicalindustryarchives.org/dirtysecrets/annistonindepth/intro.asp
>> Back to Top
Chapter 6
The following site offers a comprehensive guide to Web search engines:
www.monash.com/spidap.html
The Okanagan University College and Mount Royal College sites advise how to use a variety of traditional and electronic research tools.
www.ouc.bc.ca/libr/research/find_articles.htm
library.mtroyal.ca/
Although Robert Niles's Internet research site primarily focuses on the U.S., it does include some guidance re. Canadian sources, and Niles has good advice about interpreting statistics and technical data.
nilesonline.com/data/
>> Back to Top
Chapter 7
These sites provide wide-ranging advice on how to critically evaluate Web-based material:
biome.ac.uk/guidelines/eval/howto.html
library.usm.maine.edu/guides/webeval.html
discoveryschool.com/schrockguide/ppoint.html
writing.colostate.edu/references/trad_research/eval/index.cfm
>> Back to Top
Chapter 8
A tour of the following sites reveals that documentation "experts" have not yet agreed about MLA and APA formats for citing electronic information sources.
I recommend the Guffey site, the first listed.
www.westwords.com/guffey/documentation.html
www.columbia.edu/cu/cup/cgos/idx_basic.html
www.bedfordstmartins.com/online/citeappxa.html
This Colorado State University site has a well-organized guide to CBE style.
writing.colostate.edu/references/sources/cbe/index.cfm
This U of T site covers IEEE engineering style documentation format.
www.ecf.utoronto.ca/~writing/handbook-docum1b.html
>> Back to Top
Chapter 9
The next three sites discuss summary writing:
www.coas.drexel.edu/humanities/faculty/thury/summary_writing.html
web.uvic.ca/wguide/Pages/MasterToc.html#Summaries
writing.colostate.edu/references/documents/standsum/index.cfm
>> Back to Top
Chapter 10
The University of Toronto's Engineering Communication Centre has useful advice on using outlines and other aspects of effective writing. (Click on the appropriate sub-topic.)
www.ecf.utoronto.ca/~writing/handbook.html
www.plainlanguagenetwork.org/plaintrain/ClearAndEffectiveParagraphs.html
writing.colostate.edu/references/processes/organize/index.cfm
>> Back to Top
Chapter 11
Many Web sites provide advice about writing clear prose and exercises to improve one's editing techniques. Here is a representative sampling, starting with the Plain English Network's site:
www.blm.gov/nhp/NPR/pe_toc.html
www.sheridanc.on.ca/~sherman/rap.dir/weeks1to4/Cutfog.html
andromeda.rutgers.edu/~jlynch/Writing/
www.io.com/~hcexres/tcm1603/acchtml/lists.html
www.io.com/~hcexres/tcm1603/acchtml/acctoc.html
europa.eu.int/comm/translation/en/ftfog/index.htm
www.sec.gov/pdf/handbook.pdf
Note: probably the most useful of the above sites are the last two, a site sponsored by the European Commission's Translation Service and the U.S. Securities and Exchange Commission's Plain Language Handbook.
The University of Victoria's Writer's Guide operates this extensive site covering numerous aspects of essay writing. Though this selection focuses primarily on scholastic writing, it still provides a helpful discussion of audience awareness.
web.uvic.ca/wguide/Pages/EssayWritingAud.html
>> Back to Top
Chapter 12
The following Web sites are less commercial than most of those that deal with graphics.
www.arcm.com/illustra.html
members.aol.com/macbloom/
www.wcdd.com/dd/ddindex.html
The "New Arts of Persuasion" site shows strategies for displaying complex data.
condor.depaul.edu/~dsimpson/pers/complexdata2.html
Here's an excellent compilation of links to sites dealing with visual communication and rhetoric.
www.uiowa.edu/~commstud/resources/visual.html
Nathan Shedroff links to an amazing set of resources on interface design, information design, interaction design, multimedia, and visual design.
www.nathan.com/resources/
Two examples of a Gantt chart used to manage a project:
wps.ablongman.com/wps/media/objects/404/414115/ModelsTemplates/Chart1.pdf
wps.ablongman.com/wps/media/objects/404/414115/ModelsTemplates/Chart2.pdf
Want to work with photos that will be featured in your publications? Click on:
www.adobeevangelists.com/photoshop/index.html
>> Back to Top
Chapter 13
Literally thousands of sites offer advice about web page design. Here are three:
www.makoa.org/web-design.htm
www.wpdfd.com
www.webstyleguide.com/
Jacci Howard Bear's site sells her desktop publishing services and also provides links to excellent advice re. margins, white space, and other aspects of document page design.
desktoppub.about.com/cs/basic/a/margins.html
>> Back to Top
Chapter 14
The first site discusses operational definitions. The last two illustrate operational and categorical definitions of terms used in physics and in medicine.
www.kcmetro.cc.mo.us/longview/ctac/psychexer1.htm
www.lhup.edu/~dsimanek/glossary.htm
www.io.com/~hcexres/tcm1603/acchtml/def_ex.html
Here are examples of extended definitions.
rocktoroad.com/earth.html
nwalsh.com/docs/articles/xml/
>> Back to Top
Chapter 15
The first of the following sites presents an excellent example of extended mechanism description.
Then the next two sites discuss how to write effective descriptions of mechanisms.
www.cisco.com/warp/public/cc/so/neso/voso/voip/ptelb_rg.html
jerz.setonhill.edu/writing/technical/mechanism.html
www.ecf.utoronto.ca/~writing/handbook-rhetoric.html
>> Back to Top
Chapter 16
The Cisco site contains process description as well as mechanism description. The next site shows process descriptions from speculative science (evolution of a star) and computer software operation (true type fonts). The third site illustrates a set of instructions.
www.cisco.com/warp/public/cc/so/neso/voso/voip/ptelb_rg.html
www.microsoft.com/opentype/otspec/ttch01.htm
www.fishingnorthwest.com/flypterns.htm
These sites provide advice and examples of free on-line tutorials:
www.baycongroup.com/tutorials.htm
www.extropia.com/tutorials.html
www.w3schools.com
www.tutorials.com/
www.good-tutorials.com/
tutorials.findtutorials.com/
>> Back to Top
Chapter 17
The first site explains why it's important to write readable, usable manuals. Peter Ring's Web site on user-friendly manuals is mostly
commercial in nature, but it does contain a very useful list of free information sources. Jakob Nielsen's site discusses a variety of topics related to
usable web sites and technical writing and the Society for Technical Communicators presents its views on usability. The last two sites focus on usability issues.
www.westworld.com/~ayale/TechWrtg.html
www.prc.dk/user-friendly-manuals/
www.useit.com/
www.stcsig.org/usability/
www.w3.org/WAI/
www.hfes.org/
The first site has a manual with standard PDF layout; the second features a manual that places a hyperlinked table of contents in the left margin.
pubs.nrc-cnrc.gc.ca/aic-journals/instruct/operations-manual.pdf
http://www.radisys.com/files/support_downloads/30901_002.PDF
>> Back to Top
Chapter 18
First, you'll find the Canadian government site that provides RFPs for suppliers and contractors. Check out advice from The University of Toronto,
The University of Wisconsin(its focus on grant proposals may be useful), and Brock University. Colorado State's site is easy to use.
contractscanada.gc.ca
www.ecf.utoronto.ca/~writing/handbook.html (click on the "On-line Handbook" link)
www.library.wisc.edu/libraries/Memorial/proposal.html
www.library.wisc.edu/libraries/Memorial/grants/proposal.html
writing.colostate.edu/references/documents/proposal/index.cfm
>> Back to Top
Chapter 19
The first site lists technical reports on a commercial Web site. The next three take you to examples of technical reports, most of which have an analytical purpose. The final site, from Colorado State, gives report writing advice and an example.
www.hpl.hp.com/techreports/
www.cics.uvic.ca/climate/change/cimpact.htm
www.ec.gc.ca
www.epc-pcc.gc.ca/research/scie_tech/
writing.colostate.edu/references/documents/ce-trpt/index.cfm
>> Back to Top
Chapter 20
There are no Weblinks for Chapter 20 at this time.
>> Back to Top
Chapter 21
The sites discuss, and in some cases illustrate, a variety of job-related reports.
www.io.com/~hcexres/tcm1603/acchtml/progrepx2a_non.html
www.ecf.utoronto.ca/~writing/handbook-shrtrept.html
www.io.com/~hcexres/tcm1603/acchtml/progrep.html
jerz.setonhill.edu/writing/technical/reports/reports1.html
Here are some links to interesting material on single sourcing.
www.stc.org/intercom/PDFs/2002/200201_15-17.pdf
www.soltys.ca/techcomm/articles/the_joy_of_single-sourcing.html
www.stcsig.org/ss/articles062002/6_02_ss_Tools_article.htm
stcrmc.org/technicalities/april_may_2003/feature5.htm
www.techwr-l.com/techwhirl/magazine/technical/singlesourcing.html
>> Back to Top
Chapter 22
Letters and memos:
www.ecf.utoronto.ca/~writing/handbook-memo.html
E-mail usage:
www.nrcan-rncan.gc.ca/em-ce/emgd-e.html
www.pimall.com/nais/n.pgp.faq.html
www.webfoot.com/advice/email.top.html
www.iab.net/standards/iab_email_guidelines.asp
www.privacy.gov.au/internet/email/
larve.net/people/hugo/2000/03/email
www.exec.gov.nl.ca/exec/treasury/itpolicy/email/email_guidelines.htm
>> Back to Top
Chapter 23
Résumés: Hundreds of Internet sites dispense advice on résumé writing;
Rebecca Smith's site, www.eresumes.com, is particularly helpful regarding electronic résumés.
www.eresumes.com/
www.headhunter.net/jobseeker/index.html?iteid=cmhome
www.provenresumes.com
www.contractengineering.com
jerz.setonhill.edu/writing/technical/resume/index.html
Job market research:
www.monster.ca
www.workinfonet.ca
www.careeredge.org/
www.rileyis.com/report/index.html
www.cacee.com
www.canadajobsearch.ca
www.careerexchange.com
Cover letters:
jobsmart.org/tools/resume/cletters.html#Good
jerz.setonhill.edu/writing/technical/resume/cover-tips.html
>> Back to Top
Chapter 24
Rice University's comprehensive guide to preparing and organizing speeches may prove useful.
www.ruf.rice.edu/~riceowl/oral_presentations.htm
Stanford has a very good guide to preparing visuals that accompany speeches.
www.stanford.edu/~kunie/visual/effective.html
Kansas University's Dr. Jeff Radel has extensive on-line tutorials for designing visuals and poster presentations:
www.kumc.edu/SAH/OTEd/jradel/Poster_Presentations/PstrStart.html
www.kumc.edu/SAH/OTEd/jradel/Effective_visuals/VisStrt.html
Advice on preparing speeches:
www.speeches.com/
www.eeicom.com/eye/shyness.html
jerz.setonhill.edu/writing/technical/oral.html
Technical talks:
www.cs.wisc.edu/~markhill/conference-talk.html
Planning meetings and speaking effectively:
www.effectivemeetings.com
www.meetingwizard.org/meetings/index.cfm
www.gov.on.ca/OMAFRA/english/rural/facts/96-039.htm
www.cbsc.org/sask/sbis/search/display.cfm?Code=5914&coll=SK_PROVBIS_E
Here's a PowerPoint presentation on single sourcing:
www.stcwestcoast.ca/conf/proceedings/track4/Inge%20Zegel%20STC%20Presentation.pdf
>> Back to Top
Chapter 25
Designing Web pages is fully discussed in the many linked sites below:
trace.wisc.edu/world/web/
www.world-ready.com/readlist.htm
jerz.setonhill.edu/design/usability/index.html
These two sites present contrasting points of view on what's important in a Web site:
useit.com/alertbox/9710a.html
www.alistapart.com/articles/marsvenus/
The Society of Technical Communication publishes an electronic quarterly newsletter that helps technical communicators learn the latest developments in usability research and methodologies.
www.stcsig.org/usability/newsletter/
The World Wide Web Consortium (W3C) has begun addressing design standards in Web development to make Web pages more accessible to people with disabilities, including visual and hearing disabilities. Organizations are advocating strict adoption of these standards in all HTML design.
www.w3.org/WAI/
>> Back to Top