A Little Note on Cross-Functional Flowcharts
Tweet I’m currently documenting the business processes that will by a new system. It’s amazing how you can create different types of flowcharts depending on the process flow. One of my favorite flowcharts is the cross-functional flowchart. The cross-functional flowchart shows a process flow that has different groups that play a part to get the process from start-to-finish. Additionally, you can divide it by the sub-processes....
Read MoreCreating a Database? Have an ERD and Data Dictionary
Tweet When you are creating a system and have a database that you will be using, then you need to create an entity-relationship diagram (ERD) and a data dictionary. While creating new requirement for a new interface, I asked if they needed any assistance creating an ERD. They looked at me like I was crazy. Like I always say, documentation is always the first piece to get ignored when teams are trying to quickly design and deploy a system....
Read MoreTwo Professional Certifications Technical Writers Should Consider Pursuing
Tweet Learning is something that we should never stop doing. I’ve said this 1,000 times, but I will say it again. You can be on top of your game but if you don’t know the new and emerging ideas, technologies, and processes, then it doesn’t really matter. Since I was in my early twenties, I have always created a five-year life plan. While I was updating my career area, I have decided that in the next two years, I am going to get...
Read MoreHow to Label Your Tables and Figures in Proposals and Technical Documents
Tweet In technical documents and proposals, you will have a bunch of tables and figures (if you don’t, you should) that are visual representation of your text. In the front of the document, you will separate the lists into “List of Figures” and “List of Tables.” You want to be consistent in how you label your tables and figures in the body of the document. 1. Figure 1. Technical Solution Figure - This is not...
Read More8 Tips to Minimize Technical Jargon in Your Technical Writing
Tweet In technical documentation, you have to learn the trick of taking a complex subject and breaking it down into something that almost anyone can understand. I’ve seen a few documents that had me scratching my head because I had no clue what I was reading. You’ll lose your audience if you do that. Therefore, you really have to make an effort to not leave them more confused than before they started reading your...
Read MoreBusiness Analysts, Useful Blog Posts on Requirements
Tweet I am currently working on an e-book that will consolidate all of this into one neat package. For now, here are all the blog posts I’ve written on requirements. How to Gather Requirements and the Documentation to Help You Do It How to Write an Effective Functional Use Case Questions to Ask Yourself When Collecting and Writing Security Requirements 15 Areas to Think About When Writing Non-Functional Requirements Requirements...
Read More
