Forums for the Business Analyst

 
  Modern Analyst Forums  Business and Sy...  General  Technical writer
Previous Previous
 
Next Next
New Post 9/30/2009 6:51 PM
Unresolved
User is offline Iris
3 posts
No Ranking


Technical writer 

Hello, I am new to this forum and also this field. Can some one tell me what are the primary functions of a tech writer? By surfing the net, i have understood that Tech writers write developer manuals. when you say devolopers manuals, what do they mean? are there any samples/templates that you know of? what is the difference between func doc and dev doc?

 
New Post 10/1/2009 7:34 AM
User is offline Tony Markos
493 posts
5th Level Poster


Re: Technical writer 

Iris:

I have significant experience both as a Tech Writer and a BA.   There is a difficulty in answering your question: What, logically, a Tech Writer should be focused on and what he/she typically actually devotes most of his/her work energies to are most often two entirely different things.    This is not a "knock" against Tech Writers; the exact same issue pertains to BAs, SA, QAs, etc., etc.

I will only address what should be done.  The primary goal of a software Technical Writer should be to come up with a comprehensive, integrated understanding of the system's essential functions (i.e., business functions \  processes that exist, irregardless of any implementation consiserations) and - especially - how those functions interrelate (typically, the data flows between them).   Such is also the primary goal of a BA, but typically, the BA works to a higher level of abstraction than a TW (i.e, the BA is often most focused on the "bigger picture", while the TW is more grounded in the details.)

Difference between a functional doc and a development doc?     These mean whatever your organization says they mean.   Simular to your question, recently on the Requirements Engineering listserv, someone asked "What is the difference between a business requirement and a functional requirement".  This is a very basic question, and there are some very knowledgable people contributing to that listserv.  However, after a couple of weeks of discussion, no agreement was reached.  As a matter of fact, just yesterday, I reasked the question, and there still is no agreement:  Alot of well thought out ideas - but no agreement.  

You will find the same thing regarding your question about the difference between a functional doc (which can also be called a functional spec, functional requirements spec, a systems requirements spec, a systems functional requirements spec, etc, etc, etc) and a development doc (which can also be called a design spec, a functional spec, a technical spec, etc, etc, etc)  (Do yourself a hugh favor:  Don't listen to those who imply that there is some universally accepted definition for these, or other simular artifacts.)

Tony

 

 

 
New Post 12/15/2009 8:45 PM
User is offline katkaif
3 posts
No Ranking


Re: Technical writer 

nice topic

 
Previous Previous
 
Next Next
  Modern Analyst Forums  Business and Sy...  General  Technical writer

Community Blog - Latest Posts

As Business Analysts in Agile teams, we often hear about Definition of Ready (DOR) and Definition of Done (DOD). But beyond the buzzwords, these two concepts are powerful tools to drive clarity, consistency, and quality in our work. Definition of Ready ensures a user story is truly ready for development. It answers: Is this story clear, feasible...
In today's fast-paced digital world, successful projects aren't just built on great code—they're built on clarity. And that clarity often comes from one key player: the Business Analyst. At the heart of every great product or system is a need—a business goal, a customer pain point, or a regulatory requirement. But busines...
I have always loved cooking. I learned from my Grandma June and her kitchen was her sanctuary, a small, warm sunlit space filled with jars of spices, stacks of cookbooks, and the comforting smell of something always on the stove or baking in the oven. Grandma June was as great a cook as she was a teacher to me. She never followed a recipe “to...

 






 

Copyright 2006-2025 by Modern Analyst Media LLC