tag:blogger.com,1999:blog-39515148996734349512023-11-15T22:40:42.921+05:30Upendra's Mind Tools for Technical WritersGood Information Development skills are essential for a successful Writer.
In this blog, I am sharing my experiences in using the tools and methodogies that I have used.Upendrahttp://www.blogger.com/profile/13778173587736289354noreply@blogger.comBlogger3125tag:blogger.com,1999:blog-3951514899673434951.post-73896797316733389532010-07-02T11:31:00.005+05:302015-09-10T23:36:02.746+05:30Communication Theory<div dir="ltr" style="text-align: left;" trbidi="on">
<span style="font-family: trebuchet ms;">Communication means—transmitting information from one person to another. In this article, I am discussing about the communication triangle approach. Your writing – and any other form of communication – needs to take all three parts of the triangle into equal consideration.</span><br />
<a href="https://www.blogger.com/null" name="_Toc195939969"><span style="font-family: trebuchet ms; font-size: 130%;">The Communication Triangle approach</span></a><br /><span style="font-family: trebuchet ms;">In this approach, all you have to consider is: the intention of the writer/speaker, the subject the writer/speaker is writing/talking about, and the context and needs of the audience. However, depending on the needs one may focus on one aspect of the , and setting aside the other aspects.</span><br />
<span style="font-family: trebuchet ms;"></span><br />
<ul>
<li><span style="font-family: trebuchet ms;">Writer/speaker-centered (Ethos)—focused on examining your own response or why you responded the way you did. Building trust by establishing your credibility and authority.</span></li>
<li><span style="font-family: trebuchet ms;">Audience-centered (Pathos)—focused on convincing the audience to your way of thinking. Appealing to emotion by connecting with your audience through their values and interests.</span></li>
<li><span style="font-family: trebuchet ms;">Subject -centered (Logos)—focused on trying to understand or make sense of the subject at hand. Appeal to intelligence with well-constructed and clearly argued ideas.</span></li>
</ul>
<span style="font-family: trebuchet ms;"><img alt="" border="0" id="BLOGGER_PHOTO_ID_5489194022896119202" src="http://4.bp.blogspot.com/_bvx9cJSgG4k/TC2I4X3rraI/AAAAAAAAAJE/GaY1ly36qtk/s320/Communication+traingle.gif" style="cursor: hand; display: block; height: 238px; margin: 0px auto 10px; text-align: center; width: 320px;" /></span><br />
<a href="https://www.blogger.com/null" name="_Toc195939970"><span style="font-family: trebuchet ms; font-size: 130%;">Writer/Speaker-Centered (Ethos)</span></a><br /><span style="font-family: trebuchet ms;">Whether consciously or sub-consciously, your audience wants to know what is the motive of your communication. If you do not make it clear why you are presenting information, some of your audience will assume that you are not being very true, or that you are hiding something. Members of your audience may ask themselves:</span><br />
<br />
<ul><br />
<li><span style="font-family: trebuchet ms;">Are you providing information?</span></li>
<br />
<li>Are you trying to educate?</li>
<br />
<li>Are you making a call for action?</li>
<br />
<li>Are you attempting to persuade others to change a perspective or firmly held belief?</li>
<br />
<li>Are you presenting ideas for problem solving or analysis? Or</li>
<br />
<li>Are you just trying to entertain? </li>
<br />
<li>Where your expertise comes from?</li>
<br />
<li>Are there any expert testimony?</li>
</ul>
<br />
Your audience will be trying to analyze your motives and what you believe, value, and assume. This information helps them determine your credibility and decide whether you are being sincere. So make sure you clarify: Who you are? Why you are competent to communicate? and Where your authority comes from?<br />
<br />
<span style="font-family: trebuchet ms;"></span><a href="https://www.blogger.com/null" name="_Toc195939971"><span style="font-family: trebuchet ms; font-size: 130%;">Audience-centered (Pathos)</span></a><br />
<span style="font-family: trebuchet ms;">When you communicate, you need to understand your audience. Knowing them helps you avoid using technical terms when speaking to lay people, or “dumbing down” the content if your message is intended for professionals. Things to consider here include:</span><br />
<ul><br />
<li><span style="font-family: trebuchet ms;">What are the audience’s expectations?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">How will they use the information you provide?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">What is the audience hoping to take away after reading?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Why are you communicating to this audience in the first place? </span></li>
</ul>
<br />
<span style="font-family: trebuchet ms;">This is concerned as appealing to the emotions of the audience, which is known as pathos. If you want your audience to be moved by what you are saying. Ask yourself: </span><br />
<br />
<ul><br />
<li><span style="font-family: trebuchet ms;">What emotion do you want to evoke? Fear, trust, loyalty...?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Do you have shared values you want to draw on?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">How do your audience’s beliefs fit with your message? </span></li>
<br />
<li><span style="font-family: trebuchet ms;">Connecting with your audience through pathos is a strong means of gaining support.</span></li>
</ul>
<span style="font-family: trebuchet ms;"><br /></span><a href="https://www.blogger.com/null" name="_Toc195939972"><span style="font-family: trebuchet ms; font-size: 130%;">Subject-centered (Logos)</span></a><br />
<span style="font-family: trebuchet ms;">Finally, your audience analyzes the content and circumstances of your communication.</span><br />
<br />
<ul><br />
<li><span style="font-family: trebuchet ms;">What events preceded the communication?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">What types of arguments are used?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Are they logical and well thought out?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">How are they delivered?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Where is the document or speech delivered?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Is this communication necessary? </span></li>
</ul>
<br />
<span style="font-family: trebuchet ms;">Here the emphasis is on logic and reason. Your audience need to follow what you are saying, for it to be believable. Ask yourself:</span><br />
<br />
<ul><br />
<li><span style="font-family: trebuchet ms;">Have I presented a logical, well-constructed argument?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">How do I support my claims?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">What evidence do I have?</span></li>
<br />
<li><span style="font-family: trebuchet ms;">What are the counterarguments? </span></li>
</ul>
<span style="font-family: trebuchet ms;"><br /></span><a href="https://www.blogger.com/null" name="_Toc195939973"><span style="font-family: trebuchet ms; font-size: 130%;">Using the Communication Triangle</span></a><br />
<span style="font-family: trebuchet ms;">When you are preparing consider the three elements required for effective communication. If your communication is lacking in any of the three areas, then you will decrease the overall impact your message will have on your audience. </span><br />
<br />
<span style="font-family: trebuchet ms;">Step One: Fully consider the impact your credibility has on the message. Failing to do so will risk leaving your audience unconvinced. </span><br />
<br />
<span style="font-family: trebuchet ms;">Step Two: Fully consider your audience; otherwise, they may feel disconnected and the message will be lost. Appeal to their emotions where this is appropriate and honest</span><br />
<br />
<span style="font-family: trebuchet ms;">Step Three: Fully consider the context of your message. Ensure you deliver it with a solid appeal to reason. </span><br />
<span style="font-family: trebuchet ms;"><br /></span><a href="https://www.blogger.com/null" name="_Toc195939974"><span style="font-family: trebuchet ms; font-size: 130%;">Key Points</span></a><br />
<ul><br />
<li><span style="font-family: trebuchet ms;">By applying communication principles to your initial planning, you can significantly increase the success of your communication and it will be effective.</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Your audiences will start believing in you, and will feel you are credible, you understand them, and you are logical. </span></li>
<br />
<li><span style="font-family: trebuchet ms;">Balance Ethos, Pathos, and Logos.</span></li>
<br />
<li><span style="font-family: trebuchet ms;">Ensure your communication is clearly understood, and received with correct intention. </span></li>
</ul>
<br />
<span style="font-family: trebuchet ms;">When you reflect on -- how your message is perceived by your audience, you will be able to address their concerns even before they have a chance to rise.</span><a href="https://www.blogger.com/null" name="store"></a></div>
Upendrahttp://www.blogger.com/profile/13778173587736289354noreply@blogger.com1tag:blogger.com,1999:blog-3951514899673434951.post-38477488431847832582007-03-08T18:24:00.000+05:302007-04-20T21:45:51.033+05:30Agile (Scrum Approach) for Documentation<span style="font-family:trebuchet ms;font-size:85%;">Software development is guided by the increasing customer needs, and the challenge is to deliver usable software continuously. To address this Agile Methodology was developed. </span><br /><span style="font-family:trebuchet ms;font-size:85%;"></span><br /><span style="font-family:trebuchet ms;font-size:85%;">Agile methods deal with unpredictability by depending on people and their creativity rather than formalized processes (Cockburn, 2002). Agile methods are characterized by short, iterative cycles of development driven by product features, collaborative decision making, incorporation of rapid feedback, and continuous integration of changes into the system under development (Highsmith, 2002). Thus, agile methods operate on the principle of “just enough method” because they avoid cumbersome and time-consuming processes that add little value to the software product development process.</span><br /><span style="font-family:trebuchet ms;font-size:85%;"></span><br /><span style="font-family:trebuchet ms;font-size:85%;">In this article, I will focus on SCRUM approach for documentation that work with the development and deliver effective documentation for the product releases. </span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"><strong>Scrum</strong> is an approach that offers flexibility, adaptability, and productivity to the software development and does not define any development techniques. However, scrum focuses on how the team members function in a constantly changing environment.</span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;">Scrum Process </span><span style="font-family:Trebuchet MS;font-size:85%;">includes three phases: pre-game, development, and post-game.</span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-size:85%;"><span style="font-family:Trebuchet MS;"><strong>Pre-game Phase</strong></span> <span style="font-family:Trebuchet MS;">includes Planning and Architecture cycle. During the planning cycle a detailed plan on various sprints, duration of each sprint is estimated. A Backlog list is produced containing all requirements that are currently known and they are prioritized (a sprint), the effort needed for its implementation is assessed, and the workflow (stages) of the doc cycle is defined. In the architecture cycle, the backlog items assigned are reviewed, changes necessary to implement the backlog items is identified, a high level design (topics and structure) of various doc deliverables for all the backlog items is produced, problems or issues in developing the content is identified, and finally reassign changes as required. </span></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"><strong>Development Phase</strong></span> <span style="font-family:Trebuchet MS;font-size:85%;">is an iterative cycle. Here the Scrum team establishes the parameters such as time, quality, resources, tools, the Output format. The parameters may change during the process and they are observed and controlled during sprint review meetings of the development phase.</span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"><strong>Post-Game Phase</strong></span> <span style="font-family:Trebuchet MS;font-size:85%;">is an end of release cycle where all requirements are met and completed. In this phase the tasks such as unit testing, integration, and publishing is accomplished. </span><br /><br /><p><span style="font-family:Trebuchet MS;font-size:85%;"></span></p><p><span style="font-family:Trebuchet MS;font-size:85%;"><strong>The Process </strong></span><span style="font-family:Trebuchet MS;font-size:85%;">We followed the monthly sprint, the sprint is started with sprint planning meeting and ends with sprint review meeting. However, we also had daily review meetings (Sun Rise Meeting) in the morning to review and control the variables.</span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;">During the sun rise meeting, the information is updated in a simple sprint backlog template in the wiki; burndown chart and cumulative flow diagrams are displayed in the wiki page for everyone to view the doc status. In this course the doc team knows where they stand and it makes them feel accountable for the successful delivery of the docs for the product. This also brings in transparency to the doc status so that other teams, such as Dev, QE, Product Management, and Project Scrum Manager feel comfortable. Since, we implemented the team has had remarkable success and increased efficiency. It has helped the team to present an objective data for the end of cycle sprint meetings, and it has helped in effective estimation for the new features that needs to be documented. </span><br /><br /><span style="font-family:Trebuchet MS;font-size:85%;"><strong>Using Sprint Backlog Sheet</strong></span></p><span style="font-family:trebuchet ms;font-size:85%;">At the planning stage of each sprint, we create a Sprint Backlog Sheet that contains 8 worksheets: CFD, Burndown, Instructions, Backlog, Stats, Sprint Goals, Allocation, and Impediments. </span><br /><span style="font-family:trebuchet ms;font-size:85%;"><br /><em><span style="color:#993300;">CFD Sheet</span></em>: is a stacked area chart that displays what state each topic is in over time. It shows how many topics are in each stage for each day of the sprint. The sprint goal is to move all work items to the final stage (Release to Testing).<br /></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"><em><span style="color:#993300;">Burndown Sheet</span></em>: contains visuals on </span><br /><br /></span><ul><li><span style="font-family:Trebuchet MS;font-size:85%;">Sprint progress - how is the team doing toward meeting the Sprint goal? </span></li><li><span style="font-family:Trebuchet MS;font-size:85%;">Release progress - will the release be on time with the quality and all functionalities documented? </span></li><li><span style="font-family:Trebuchet MS;font-size:85%;">Product progress - how is the doc deliverables filling out compared to what's needed? </span></li></ul><span style="font-family:trebuchet ms;font-size:85%;"><span style="color:#993300;">Backlog Sheet</span>: contains all of the topics that we agree to complete during the sprint. It also contains the following details: the backlog Item number, date created, the current sprint number unless carried over from prior sprint; can be blank, status, codes, activity type, initial estimate of hours to complete task, resource - team member(s) who signed up during planning session, and daily burndown updates. </span><br /><span style="font-family:trebuchet ms;font-size:85%;"><br /><em><span style="color:#993300;">Stats Sheet</span></em>: contains the source data that generates the CFD. Every day we input the counts of work items in each state.</span><br /></span><br /><span style="font-family:Trebuchet MS;font-size:85%;"><span style="color:#993300;"><em>Sprint Goals Sheet</em></span>: contains the sprint objective(s)</span><br /><br /><span style="font-family:Trebuchet MS;font-size:85%;"><em><span style="color:#993300;">Allocation Sheet</span></em>: contains work through allocation vs. capacity data</span><br /><br /><span style="font-family:Trebuchet MS;font-size:85%;"><em><span style="color:#993300;">Impediments Sheet</span></em>: contains impediments for the sprint on a daily basis</span><br /><br /><span style="font-family:trebuchet ms;font-size:85%;"><strong>Daily Scrum Meeting</strong></span><br /><span style="font-family:trebuchet ms;font-size:85%;">We have daily sunrise meeting in same place & time each day (15 minute max):</span><br /><span style="font-family:Trebuchet MS;font-size:85%;">The following points are discussed: </span><br /><br /><br /><br /><ul><li><span style="font-family:trebuchet ms;font-size:85%;">What a team member is accomplished since the last Scrum?</span></li><li><span style="font-family:trebuchet ms;font-size:85%;">What will h/she work on between now and the next Scrum?</span></li><li><span style="font-family:trebuchet ms;font-size:85%;">What impediments or obstacles do h/she need help with?<br /></span></li></ul><p><span style="font-family:trebuchet ms;font-size:85%;">Some of the rules we set for the sunrise meeting are</span></p><span style="font-family:trebuchet ms;font-size:85%;"><ul><li>Punctuality is mandatory - we introduced punishments, some of the penalty ideas are donating Rs. 100 to team's favorite charity, Must tell a joke at the end of the Scrum, Must sing a song at the end of the Scrum </li><li>Attendance at each Scrum is mandatory; few exceptions are allowed</li><li>If a member will miss a Scrum, h/she must let the Scrum Master know </li><li>Written status to Scrum Master</li><li>Scrum Master reads status </span></li></ul><p><span style="font-family:Trebuchet MS;font-size:85%;">For sample sheet contact me: <a href="mailto:upendranb@gmail.com">upendranb@gmail.com</a></span></p><p></p>Upendrahttp://www.blogger.com/profile/13778173587736289354noreply@blogger.com0tag:blogger.com,1999:blog-3951514899673434951.post-2579930858708071342007-03-08T13:57:00.001+05:302010-07-02T00:33:46.851+05:30Estimating your Technical Writing Project<p><span style="color:#ffffff;"><span style="font-family:trebuchet ms;font-size:85%;"><span style="color:#000000;">I was engaged in a pre-sales activity and one of the clients gave me few functional specs and requirement docs and asked me to come up with an estimate for an user guide.<br /><br />That is when I began to look at different tools and methods used in estimating, and I explored the following options to provided estimates:<br />· Based on SWAG (scientific wild-ass guess)<br />· Based on previous (historical) data for similar kind of project<br />· Based on industry standard<br /><br /><strong>SWAGing it Out</strong><br />I went into a huddle with my team and asked them to take a guess and come up with an effort time for the project. Every one had different values; Team Member A gave 200 hrs, Team Member B gave 250 hrs, and Team Member C gave 215 hrs, and so on. I was in a fix, whom to consider? Each team member's expertise varied, one was good in information gathering, and the other in outlining the framework, and so on.<br /></span></span><br /></span><span style="color:#000000;"><span style="font-family:trebuchet ms;font-size:85%;">I took the approach of looking back at what we have accomplished (historic data), and come up with the number for the current set of requirements. </span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span></span><span style="font-family:trebuchet ms;font-size:85%;"><br /><span style="color:#000000;"><strong>History shows that we made it; if we pursue, we can do it this time too</strong><br /><br />The challenge was to dig deep and pull out the numbers (effort time) from the documentation project we had undertaken earlier. When I began to do this, I found that for few of the projects I could get some values and for most I could not, because no effort was made in capturing the effort time for the entire life cycle.<br /><br />Back to Square One, confidence on the estimate was low. Looking at the industry standard was the other option that was left with me to come up with an estimate.<br /><br /><strong>How others estimate? What is the Ball Park? Can we apply it?</strong><br /><br />I assumed if I start googling out, I could come up with the numbers used by the industry for estimating. When I did that, I had the following questions:<br /><br />· How many pages, one can produce in a day?<br />· How scope changes was handled?<br />· How complex was the project?<br />· How many new topics and updates were accomplished?<br />· What was the strength and experience level of the team members?<br />And so on.<br /><br />The numbers for each scenario (complexity, audience, domain, skill, and so on) were different; however, I arrived at project estimates sans confidence or comfort. </span></span></p><p><span style="font-family:trebuchet ms;font-size:85%;"><span style="color:#000000;"><strong>There is no way to come up with an accurate estimate, estimates are just guesstimates.</strong> This thought was ethched in my brains, but I had to overcome this to be effective. Hence, </span></span><span style="color:#000000;"><span style="font-family:trebuchet ms;font-size:85%;">I worked on a formula to increase my confidence over the estimates arrived based on standards used in an e-learning project estimation, and the formula is:<br /><br />A (Estimates) = xx hrs<br />B (Project Loss Time) = 15% of A<br />C (Sub Total 1) = A + B<br />D (Labor Contingency) = 20% of C<br />E (Non Project Loss) = 15% of C<br />F ( Grand Estimate) = C+D+E<br /><br />For example,<br />Estimates = 200 hrs<br />Project Loss Time = 200*15% = 30hrs<br />Sub Total 1 = 230 hrs<br />Labor Contingency = 230* 20% = 46hrs<br />Non Project Loss = 230*15% = 34.5 hrs<br />Grand Estimate = 230 + 46 + 34.5 = 310.5 hrs<br /></span><br /></span><span style="color:#000000;"><span style="font-family:trebuchet ms;font-size:85%;">I was satisfied with the result, and we submitted our estimates and were awarded the project. The estimates we made were almost correct (85% confidence), a great number to achieve. However, it did not stop me from exploring better ways to estimate effectively.<br /><br />That is when I was introduced to Three-Point estimation technique. This technique gave me confidence in building an estimation process that has worked 95% of the time (for me).<br /><br />The <strong>Three Point Estimation Technique</strong> is based on statistical methods (Normal distribution).<br />In Three Point Estimation, three values are calculated for every estimate:<br />a = the best case estimate (optimistic)<br />m = the most likely estimate<br />b = the worst case estimate (pessimistic)<br /><br />These values are used to calculate weighted average (E value) for the estimate and a Standard Deviation (SD) where:<br />E = a + (4*m) + b / 6<br />SD = (b - a)/6<br /><br />E is accounted both in the optimistic and pessimistic estimate, and SD measures the variability or uncertainty in the estimate.<br /><br />To produce a project estimate:<br /><br />· Decompose the project into a list of estimable tasks (Work Breakdown Structure)<br />· Estimate the E value and SD for each task<br />· Calculate the E value for the total project work as E (Project Work) = Σ E (Task)<br />· Calculate the SD value for the total project work as SD (Project Work) = √Σ SD (Task) 2<br /><br />Then use the E and SD values to convert the project estimates to Confidence Levels as follows:<br />Confidence Level in E value is approximately 50%<br />Confidence Level in E value + SD is approximately 70%<br />Confidence Level in E value + 2 * SD is approximately 95%<br />Confidence Level in E value + 3 * SD is approximately 99.5%</span><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><br /><span style="font-family:Trebuchet MS;font-size:85%;">Here is a tool developed based on Three-Point Estimation Technique for our documentation projects and it is </span><span style="font-family:trebuchet ms;font-size:85%;">based on ideas (templated designed) by Margie Yundt & Sherry McMenemy, Jim Chapman, and PMBOK . Although this tool is still a work-in-progress, I am happy to share what I’ve got so far.</span><br /><br /></span><iframe style="WIDTH: 500px; HEIGHT: 400px" src="http://sheet.zoho.com/publish.do?docurl=UUtJMWVbXw3%2F1dXoz985GAVhFlogXsivUw7%2BFqwQc%2FU%3D&name=4WKHb0yBODDcyRhMyDvwuA%3D%3D" frameborder="0" scrolling="no"><br /></iframe><br /><span style="font-family:Trebuchet MS;font-size:85%;"></span><br /><span style="font-family:Trebuchet MS;font-size:85%;color:#000000;">For more on the tool, see my article on Three-Point Estimation Tool for Documentation.</span></p>Upendrahttp://www.blogger.com/profile/13778173587736289354noreply@blogger.com0