Quantcast
Channel: Technical Writing and Communications — TechWhirl Community Forums
Browsing latest articles
Browse All 106 View Live

If app icons are white on black background should they be inverted in help...

Hi,The app has a black toolbar with white icons on it. When writing theprocedure I include the icon to the step, for example, "Tap Add [+]". Thewhite plus icon on black background looks strange, but...

View Article



Image may be NSFW.
Clik here to view.

The Help Files: You’ve Been Laid Off. Bah Humbug! | TechWhirl

The Help Files: You’ve Been Laid Off. Bah Humbug! | TechWhirl You all know about the late afternoon shoulder-tap, right? It usually arrives after you have recovered from lunch, but before you can...

View Article

Wikipedia: Copyright issues when uploading a photo

Hi,When my client or I upload a photo to his Wikipedia page, the photo gets hit with a number of copyright warnings by Wikipedia, who also say the photo will be deleted on a certain date.The client is...

View Article

Image may be NSFW.
Clik here to view.

Linking Algorithms and Structured Writing | TechWhirl

Linking Algorithms and Structured Writing | TechWhirl Mark Baker looks at the details of how linking algorithms support structured content and the ability of the reader to engage in information...

View Article

Anybody doing docs for HITRUST certification?

Hi there. I just started a new TW gig where I'll be working on HITRUST certification documents. (If you're not familiar, HITRUST is an organization that creates and administers a data security...

View Article


Customizable Online-Help?

Hi there, I hope someone can help me with this issue since I do not have the experience. Our company got a request from a customer that he wishes to customize our online help. That means, we provide...

View Article

Acronyms extraction software

Greetings, fellow technical communicators,I work on avionics documentation that includes many acronyms/abbreviations/initialisms (all of which we shall refer to herein as "acronyms"). In each document,...

View Article

Style for Navigation

Hello,I'm trying to find a style guide or advice about best practices for describing navigation in technical documentation. My team's style is to use arrows, for example, "To locate the user manual, go...

View Article


Tech Writer Hiring Plan/Proposal - Examples

I manage a 3-person tech writing team at a software company. My manager asked me for a Tech Writer Hiring Plan/Proposal he can present to the executive staff. Basically, he wants to know my staffing...

View Article


Departmental help for a cloud application

I'm going to be developing departmental help for a cloud-based application.That is, I will be creating help that tells an employee how we're going to use the software. For example, let's say it's HR...

View Article

Depth of Documentation in a LIMS User Manual

Hello everyone,I have a question and I need the advice of veteran tech writers.I'm starting to write a reference-based user manual for a quite large LIMS application. And there are actually many fields...

View Article

Looking for an alternative to term "Internal Task"

I have two communities - one payer (my own) and another partner. In a program created for a partner, I have a set of tasks that a partner would perform. I have kept a task called "Internal task" in...

View Article

inapplicable or non-applicable

Hi,I always get myself confused when it comes to wording...Here it comes again: which is correct or more widely used, inapplicable or non-applicable, I mean in American English.Example: Choose either...

View Article


Question about style usage

I can't find any info regarding this scenario. I'm looking for some help!How should I refer to "space" in the following:"Two new values will be added to the system. Users can enter a space or a...

View Article

errata for references

Hi there.I have recently published a book which I forgot to reference a blog post that helped me on the research.I think it's important to add it (and it was really a lack of attention when writing in...

View Article


Right-Angle Brackets in Navigation Steps?

There's some disagreement within my team regarding the use of right-angle brackets to concatenate on-screen navigation sequences: 2. Click Start > Settings > DSP > Provision. versus... 2....

View Article

Adobe Worldwide Tech Comm Survey 2017–2018

Adobe's yearly survey launched earlier this week - make your voice heard:http://blogs.adobe.com/techcomm/2017/12/adobe-worldwide-tech-comm-survey-2017-2018.html

View Article


Writing samples and NDAs

Hello,I'm new to this forum. Right now I'm preparing to apply for tech writing jobs, and I've prepared a set of samples to show potential employers. However, I'm concerned about potential conflicts...

View Article

Software documentation

I need more notes on that please...

View Article

Documentation site semantic organization

In a lot of companies the documentation is unfortunately the last thing that developers focus on. As documentation writers would you be interested in a tool ,which just takes all the dis-organized...

View Article

Accomodating wide tables in Madcap Flare

My Flare table has 13 rows, and it is not coming up properly in the web help. Only 4 rows are visible in the browser. Some rows/cells have content without any white space (e.g. a URL). What can I do to...

View Article


Tools--creating an elearning course for a cloud developer platform

Hi everyone, Just wondering if anyone has any suggestions for elearning courseware creation tools--specifically for a developer audience. Right now I am adapting an instructor-led course into a...

View Article


How to break in?

About me:I've been trying to get into technical writing. I have a graduate degree in writing and one year of experience in writing technical marketing materials but using only Word and the likes.I know...

View Article

Everything I Need to Know As a Technical Writer I Learned In High School

Everything I Need to Know As a Technical Writer I Learned In High School Not many of us started off here. Although it seems that the field has been growing steadily for twenty years, there haven't...

View Article

Transitioning to Technical Writing

I majored in journalism in undergraduate and graduate school and I am interested in transitioning to technical writing. The problem is I don't know what steps to take. I've done some research and I'm...

View Article

Browsing latest articles
Browse All 106 View Live




Latest Images