Re: Large Documents in Word
100 pages? Heh. Tech writers have testified to Word documents that they maintained with 300, 600, over a thousand pages, complete with graphics and tables.
Of course, this requires a lot of training. Jonathan West wrote, "You have to put as much effort into learning it as you would have to in order to learn Frame."
If I'm not mistaken, the particular reason for the shift from Frame to Word is so that the SMEs can modify the documentation source directly, presumably saving some effort.
Perhaps the SMEs would not mind if tech writers were permitted to make changes directly to their C++ source code? Just adding comments, nothing more.
Not only does everyone know how to use Word, but everyone knows that /* and */ delimit comments in C++, and that // indicates comments on a single line.
What could possibly go wrong?
Here's an example. We take this code:
// Our Fine Example
#include<iostream>
using namespace std;
int main()
{
int a = 3, b = 5; /* Use last values set */
a = 4, b = 13;
a = 2, b = 35;
cout << a << " + " << b << " = " << (a+b) << endl;
return 0;
}
and we'll just add two comments...
// Our Fine Example
#include<iostream>
using namespace std;
int main()
{
int a = 3, b = 5; /* Use last values set */
a = 4, b = 13; /* Do we use these? /*
a = 2, b = 35; /* No, it's these, right? */
cout << a << " + " << b << " = " << (a+b) << endl;
return 0;
}
It still compiles without error and runs.
Have we hurt anything?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
References:
Large Documents in Word: From: Lin Sims
Re: Large Documents in Word: From: Chris Morton
Re: Large Documents in Word: From: Lin Sims
Re: Large Documents in Word: From: Shawn
RE: Large Documents in Word: From: Dan Goldstein
Previous by Author:
Re: Large Documents in Word
Next by Author:
RE: Is the STC worth it?
Previous by Thread:
RE: Large Documents in Word
Next by Thread:
RE: Large Documents in Word
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads