technical writing tips and articles for companies and individuals

technical writing

Be an Independent Writer; Stop Bothering People

Posted by on Mar 25, 2011 in proposal writing, technical writing | 0 comments

Be an Independent Writer; Stop Bothering People

Tweet As a freelance writer, I have learned to be independent. Yes, I get some guidance from clients from time-to-time, but I have also learned how to deal with life’s little problems. As a Technical Writer/Proposal Writer, I’ve learned how to quickly pick up complex processes that need a bit of technical knowledge. In this contract that I am currently on, I’m not the Technical Writer. I am in the Senior Analyst position, so my...

Read More

Writing A Gap Analysis Document

Posted by on Mar 24, 2011 in technical writing | 0 comments

Writing A Gap Analysis Document

Tweet Awhile ago, I wrote about how to conduct a gap analysis session. Today I realized that I never really discussed how to put everything together into a document that can be of use to all parties involved. Therefore, I decided to write about it now. I haven’t really seen a “proper way” to create a gap analysis document. Therefore, you have probably seen different versions of it. This is the one that I put...

Read More

Technical Writers, Find Your Voice but Be Consistent

Posted by on Mar 21, 2011 in technical writing | 0 comments

Technical Writers, Find Your Voice but Be Consistent

Tweet In writing, there are different kinds of style manuals.  Academics usually refer to the MLA Style for their writing.  Journalists usually think of AP Style.  Book writers might follow the Chicago Manual of Style.  APA Style is what people in the social sciences usually adhere to.  If you are writing in the government sector, you know about GPO Style.  I know there are more, but these are the main ones that people usually use. ...

Read More

Writers, How to NOT Treat Your Clients

Posted by on Mar 3, 2011 in proposal writing, technical writing | 0 comments

Writers, How to NOT Treat Your Clients

Tweet Writing can be scary for some people, just like technology can be.  Combine the two, and it can be extremely frightening.  Therefore, you have to learn how to be patient, talk to your clients, and not take advantage of the power that technical writers and proposal writers can sometimes have.  Even though I have said that I am not offering any writing and editing services at the moment, I decided to help an organization with their...

Read More

Take Good Notes for Great Technical Writing

Posted by on Feb 15, 2011 in proposal writing, technical writing | 0 comments

Take Good Notes for Great Technical Writing

Tweet When you’re tasked to create a document, you have take good notes when talking to the developers, subject-matter experts, and users, especially if it’s in an area that you are not too familiar with. When I was working on this planning, programming, budgeting, and execution system, I took notes that I could use to produce the documentation that was needed.  If I didn’t understand something, I made sure to ask the person I...

Read More

Free Use Case Template for Requirements Gathering

Posted by on Feb 8, 2011 in business analysis, technical writing | 0 comments

Free Use Case Template for Requirements Gathering

Tweet I have been writing a lot of use cases and requirements documents lately. One of the things that people are always asking is if there is a template to document their use cases. I created this one that people can use to do just that. Hope it helps! Use Case Template...

Read More