They're probably having you write it to get you familiarized with how things are done there. I bet the company has their own standards and will give you a couple of days of training on how they want their software documented. But "software documentation" sounds too general, and could be written for different audiences. It could be a use case, functionality documentation, process documentation, or a combination of any of those things. If you've got good grammar and have the ability to communicate well, you have nothing to worry about. Maybe throw in a few good suggestions of your own. Oh, and maybe pretty charts and colors HAHA.
> For my new job, they said the first week will consist of writing > software documentation, I assume to help familiarize me with the > projects. I don't really have any experience doing formal software > writing and would like to not look like an idiot. Can anyone point me > to a good beginners guide online? Any tips here would be appreciated > as well. Wikipedia had a couple of good pages but I'm looking for > something more in depth. > > Basically, what is expected? The ins and outs of each page? What is > displayed on each page? The variables involved? What are they > looking for? > > Thanks. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Adobe® ColdFusion® 8 software 8 is the most important and dramatic release to date Get the Free Trial http://ad.doubleclick.net/clk;192386516;25150098;k Archive: http://www.houseoffusion.com/groups/CF-Community/message.cfm/messageid:258074 Subscription: http://www.houseoffusion.com/groups/CF-Community/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.5
