Questions tagged [technical-writing]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
0
votes
0answers
22 views

software methodology for technical proposal [on hold]

I have a TOR for the project Personnel Management Information System (PMIS) with HRMS system in Technical part they want proposed solution methodology. Additional information on the technical proposal ...
0
votes
1answer
140 views

Insert Keyboard Shortcuts

I'm writing a user's guide for my software. Is there an easy way to insert keyboard shortcuts in a word document? Here's an example of what I'd like to have in my document: CtrlS I can probably do ...
0
votes
1answer
164 views

“Baudrate” or “Baud Rate” [closed]

In the context of technical writing (e.g: documentation), would it be more correct to use "baudrate" or "baud rate"? I believe that both are acceptable informally. However: I've often seen "...
19
votes
5answers
3k views

What is the technical term for current (.) and parent (..) directory?

I got a function that checks whether the passed in file name is . or ... But I don't know how to name it properly. Something like IsCurrentOrParentDirectory() is ambiguous, since the function takes a ...
2
votes
2answers
854 views

Regular Expression Help Needed in Notepad++

I need to know the syntax for a regular expression (notepad++) to help me find/replace every instance of following string in a text document the string is as follows Where do you want to go next? ...
1
vote
3answers
98 views

Software for formatting / web-publishing tutorial-type, technical articles

I want to put some of my own technical writing on the web: tutorials, how-to's, conceptual articles about programming etc. I write mostly for myself yet, but think others can benefit from it so I want ...
3
votes
1answer
280 views

What is an ISO file extension regarding a graphics file?

I've worked with ISO 9660 images files before, but now I'm working with Arbortext, a documents processing COTS software product for work with technical manuals. It's taking a CGM file with redlining (...
-2
votes
2answers
462 views

Templates for writing a Turkish programming book in Microsoft Word 2007 [closed]

I am going to write a simple book on programming in Turkish but I am not sure how I design my MS Word doc. It would be great to have a template to get a head start. Do you know any?
9
votes
4answers
45k views

How to represent [RETURN] key in MS Word

I am writing a technical document in MS Word 2007, which needs to show the reader how to execute some commands on the operating system. Something like: C:\script_dir> run.bat [RETURN] Many ...
-2
votes
3answers
2k views

Alternatives to the Stylewriter program [closed]

I have just gone to Windows 7 64-bit and the StyleWriter program is not compatible. Does anyone know of a program that looks for passive verbs and sentence length of 20 words? I want a program, that ...
7
votes
4answers
1k views

Dealing with Word spell check in technical documents?

I have waste millions of hours clicking the Ignore Once button in Word, while trying to spell check a document related to development. Be that something light on terms like a proposal or something ...
0
votes
1answer
478 views

Adobe InDesign + third party plugins vs. Framemaker

Apropos of this posting on Stackoverflow, I'd quite like to hear anyones experiences on using Adobe InDesign/InCopy plus third-party plugins such as those listed here. Specifically, how good would ...