I suspect many developers here have had to write a technical manual for
their software, and I'm wondering if you have any info as to industry
standards for formatting.
For example, should a screen shot be included for each edit screen? If
so, how big? What if the picture won't fit on the page with the
corresponding text?
I realize the best way is to hire someone who knows all of this stuff,
but we can't afford it. Thanks!
3  5532 
Can't stand writing them myself, damn things drive me nuts and take forever
and a day.
As far as screenshots go, though some would say to only include whats
necessary, the support e-mails I've received tell me every tiny detail
should be shown and explained.
As far as it not fitting on the page, most CHM editors allow you to use
thumbnails that link to larger screenshots (different app's have different
methods so cannot be more specific as to how).
As far as industry standard formatting goes, plane Jane HTMLHelp files
produce whats necessary. The older hlp format is apparently depracated and
PDF's are just a royal PITA
--
Regards
Steven Burn
Ur I.T. Mate Group www.it-mate.co.uk
Keeping it FREE!
<la**********@y ahoo.com> wrote in message
news:11******** **************@ g14g2000cwa.goo glegroups.com.. . I suspect many developers here have had to write a technical manual for
their software, and I'm wondering if you have any info as to industry
standards for formatting.
For example, should a screen shot be included for each edit screen? If
so, how big? What if the picture won't fit on the page with the
corresponding text?
I realize the best way is to hire someone who knows all of this stuff,
but we can't afford it. Thanks!
<la**********@y ahoo.com> wrote in message
news:11******** **************@ g14g2000cwa.goo glegroups.com.. . I suspect many developers here have had to write a technical manual for
their software, and I'm wondering if you have any info as to industry
standards for formatting.
For example, should a screen shot be included for each edit screen? If
so, how big? What if the picture won't fit on the page with the
corresponding text?
I realize the best way is to hire someone who knows all of this stuff,
but we can't afford it. Thanks!
What format will you be using -- MS-Word, Web page, or?
How will it be made available -- hardcopy, PDF, Web site, CD-ROM, or ?
What will you be documenting -- an application, a procedure, or ?
Google:
Online Technical Writing: Book Design http://www.io.com/~hcexres/tcm1603/a...ok_design.html
Technical Writer (Technical Manuals/Reports Writing Software)
$150 http://www.writersupercenter.com/stylewriter/technical/
Steven Burn wrote: Can't stand writing them myself, damn things drive me nuts and take forever
and a day.
As far as screenshots go, though some would say to only include whats
necessary, the support e-mails I've received tell me every tiny detail
should be shown and explained.
As far as it not fitting on the page, most CHM editors allow you to use
thumbnails that link to larger screenshots (different app's have different
methods so cannot be more specific as to how).
As far as industry standard formatting goes, plane Jane HTMLHelp files
produce whats necessary. The older hlp format is apparently depracated and
PDF's are just a royal PITA
I was writing it in Word, and creating a PDF. No good?
Word automatically creates a table of contents of proper styles are
used, and when it converts to PDF, the PDF index is automatically made
as well. This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics | |
by: johnathan |
last post by:
How can I use a php script running on my web server to read in the
html source from an arbitrary webpage and then write it to a file on
my web server?
|
by: xo55ox |
last post by:
Hi,
I just build a website and need to somehow trap the user logon and
1) display 'welcome! so and so' at the left hand corner of the page.
2) valid whether the user exists in my MySQL database, user table.
How do I do that?
Thanks for your help!
|
by: xo55ox |
last post by:
Hi,
I want to find out how do I display the user who logon to the webpage,
such as, Welcome, xxxx! Also how do I validate against my user table
in MySQL database whether the user is an existing user or new user.
Will appreciate any information.
Thanks.
|
by: Nick Evans |
last post by:
Hello there,
I have been on and off learning to code (with python being the second
language I have worked on after a bit of BASIC). What I really want to know
is, if you are going to actually write a program or a project of some sort,
how do you actually start.
Picture this, you know what you want the program to do (its features), you
have a possably rough idea of how the program will work. You have opened an
empty text file and saved...
|
by: Rado |
last post by:
Hello.
Can anybody write me some links, where can I find some good manual for
writing own windows control?
Thanks.
| | |
by: Antonios Christofides |
last post by:
Hi, I've prepared a test case about this, which I include below. I
have tables "a" and "b"; "b" has a foreign key to "a", on delete
cascade. In addition, there is a "before delete on b" trigger, which
all that does is show the current_user. If a row is deleted from "a",
and this triggers a delete from "b", which in turn activates the
show_current_user trigger, the triggered function selects
"current_user", and the result is the user who...
|
by: gnewsg |
last post by:
Hi all. I've just finished to write an FTP daemon in Python.
To do things well I'd like to write an 'insteller' to permit the end
user to 'deeply' install the package inside the system. In details I
would like that installer is able to do the following operations:
- copy ftpd.py in /usr/bin.
- depending on the system, it should be able to determinate where
service startup directory is located (for example /etc/init.d) and
copy a script...
|
by: The1corrupted |
last post by:
Alright, I'm embedding HTML, Javascript, and CSS all in PHP and right now, the javascript isn't functioning properly.
<script type='text/javascript'>
var contents=\"\";
function dispcontent() {
var contents='1';
}
</script>
</head>
<body class='leftstyle'>
|
by: shivapadma |
last post by:
1. i want to write a stored procedure using mysql 5.0.45 version.
2. when i tried with the following code ,i am unable to write
mysql->delimeter//
->create procedure proc(out p1 int)
->select count(*) into p1 from emp;
when i pressed enter, the following error is appeared .
|
by: Hystou |
last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it.
First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
|
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed.
This is as boiled down as I can make it.
Here is my compilation command:
g++-12 -std=c++20 -Wnarrowing bit_field.cpp
Here is the code in...
| | |
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth.
The Art of Business Website Design
Your website is...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert into image.
Globals.ThisAddIn.Application.ActiveDocument.Select();...
|
by: TSSRALBI |
last post by:
Hello
I'm a network technician in training and I need your help.
I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs.
The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols.
I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
|
by: 6302768590 |
last post by:
Hai team
i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
| | |
by: bsmnconsultancy |
last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...
| |
