+91-7827916060 study@ect.co.in

Technical Writing

Home Forums Technical Writing

Viewing 6 reply threads
  • Author
    Posts
    • #4884
      Saket Kumar SinghSaket Kumar Singh
      Keymaster
      @saket

      Write your main takeaways from the class “Technical Writing.” Don’t refer to or get influenced by what and how others have written. Rather, recall the concepts discussed in the class and write them in your words. Focus on key concepts or things you learned and how you will implement the same to transform your writing style.

       

      Don’t use bullet points. Write in paragraph form. Your content should have at least 150 words.

       

      All the best!

    • #5644
      Anju BahlAnju Bahl
      Participant
      @anju

      Key Takeaways From Class Held On 19th October,2019
      Technical Writing the topic.The main focus is on the audience.It is based on facts and not on personal opinions.Accuracy is maintained.Triangular Theory Of Love by Robert Sternberg was discussed.To become a Technical Writer fear of Maths and Science is to be removed.Ask questions and do adequate research.

      White Paper,Product Description,User Manuals,Scientific Papers and Reports are some of the types of Technical Writing.Every writer can not be a Subject Matter Expert(SME) and vice versa,thus giving a rise to the need for technical writers.
      First of all,identify your audience,know the format and then understand the topic.Understanding technology is a major problem with many.Ascertain which problem is the topic addressing to.Understand through real life examples.

      All rules of Business Writing are applicable in Technical Writing too. Prewriting is a must in Technical Writing.Learn in bits n pieces and explain in your own words.Gather accurate information from various sources.

      A White Paper is written to attract investors.It is an abstract telling about the problem in the current market.This concept was primarily introduced by British.It deals with issuing of tokens for investment purpose and why investments should be done this way.RBI handling money is a very good example.

      Artificial Intelligence(AI) is the intelligence acquired by machines.Here these machines imitate decision making abilities of humans.Some good examples of AI are Gmail,Google Search,Google Maps,Siri,Self Driving Cars etc.

      Internet Of Things(IOT) can be understood through Functional Diagrams.The main elements are Sensors or Devices,Connectivity,Data Storage and Processing and User Interface.The main technical topics are AI,Big Data and Machine Learning,Block chain and Crypto Coin Desk.Certain specialised fields like Legal,Finance and Accounting involve Technical Writing.

    • #5735
      Sanjay SharmaSanjay Sharma
      Participant
      @sanjayk6f

      The class held on the 10th was informative. It was a technical writing class which brought change in thinking and analyzing things as a writer. It requires a strong base in general writing, including knowledge of grammar and punctuation rules.

      We learned how technical writing is different from creative writing? The class commenced with the “Triangular Theory of Love,” we all generated a copy of 100 words, Saket, sir, listened, and shared feedback with us.

      Technical writing has seven components, including, figures & tables, maintain consistency, use appropriate language, create text flow, use correct grammar, punctuation rule, improve the text, and peer review.

      Technical writing is an expert information-driven copy of a particular subject. We discussed how minor changes in technology brought extensive changes in all the aspect of people’s lives. We well-understood through the example. In the next session, we knew how to research technical writing. What are the significant elements we need to consider while producing the professional copy? A writer should avoid flowery style and stick with practical information.

      All the rules of business writing format are applicable here.

    • #6061
      nilja patelnilja patel
      Participant
      @npatel

      Technical writing is different from all other writings. So, in our class, we have to understand the Art and Science of Technical writing. It is different in the way of communication of the same. The writer should be an expert if wish to write the Technical content or they have to learn the expectation about all the technical things. e.g If any writer writes for the A.C. model then one should know how it functions and learns about the technical part of the A.C. Same as, if someone is writing about the Article on the knee pain, then one should be expert in that field or learn the technical content of it. The audience is the most important and critical part of technical writing. There are certain categories of technical writing such as Architecture, Design, Material, Compliance, Sanitation, Facility management. However, 2 BHK, 3 BHK, Flats, Vastu, Area, Location, etc are non-technical parts. We have given the exercise to solve then: “Triangular theory of love” no more than 100 words. Then we learned the basic understanding of technical what do we have to keep in mind. Also, all the business writing rules is applicable in Technical writing. The prewriting process in this is a little different than other writing.

    • #6256
      Upasna RaiUpasna Rai
      Participant
      @upasna22

      The takeaways from today’s class are as following :
      Today’s topic was Technical writing which means giving specification about anything. It’s all about explaining to the readers.
      Firstly, we learned about technical communication. Academic writing is the part of technical writing. From expert to learner. Audience’s focuses on technical communication or audiences tastes should be taken. Facts based is required but today specific accuracy is crucial.
      For example : Residual house where buyers knowledge must be known, expert views than strategies it. Sir gave the topic of love we had to write about it in thirty words. Sir also taught us about the three psychology theory of love: intimacy, passion, or commitment components. Something becomes technical because it validates over a period of time. For example references or researches.
      Secondly we also learned about how to understand new technology. Problem solving basics, new terms and its purpose, system with equipment or machine, nomenclature is to measure new terms. A data becomes big data when it has the structure, or block chain which instance is transaction. Thirdly, we learned about Rewriting where audiences analysis is added, sentences description from public domain. Fourthly, we learned about drafting in complex where basics are identified or solved, asking lots of questions, expecting a gradual change, or explaining the concepts. Fifthly, we learned about how to get accurate information by technical studies. Artificial intelligence is an approach where machine imitates decision-making of humans, new learning, processing, nomenclature with big ideas, or giving real life examples. Lastly, we learned about understanding through functional diagrams.

    • #6287
      Vishnu Kant SrivastavaVishnu Kant Srivastava
      Participant
      @vkant

      Takeaway Notes from meeting dated 4th Jan 2020 (Sat.) on Technical Writing

      1-Technical Writing
      Technical Writing is an art and also a science. It is a communication between an Expert and a Learner. Academic writing is an example of a technical writing.
      Technical means a knowledge that is not widespread. Technical Writing is always audience specific. So, it should always be determined, a-priori, what kinds of audience are going to read this.
      The Technical Writing is to fact based. It requires accuracy. The writing may not be engaging to the readers.

      Exercise : Let us write a technical writing. Define love ?
      Ans:
      Love is to like somebody or something in the strongest possible way so as to care about it, and protect it in all circumstances.

      Let us research Psychology and examine the theory “Triangular Theory of Love”
      – The three components of love, according to the triangular theory, are an intimacy component, a passion component, and a decision/commitment component.
      – Intimacy refers to “feelings of closeness, connectedness, and bondedness in loving relationships
      – Passion refers to “the drives that lead to romance, physical attraction, sexual consummation, and related phenomena in loving
      – Decision/commitment means different things in the short and long term. In the short-term, it refers to the decision that one loves a certain other, and in the long-term, it refers to one’s commitment to maintain that love.
      – Passionate love converts into Companionate love after sometime. Companionate love follows passionate love.
      – Intimate love is the corner of the triangle that encompasses the close bonds of loving relationships.
      – Commitment, or committed love, is for lovers who are committed to being together for a long period of time.

      In technical writings, validated facts are enumerated. Accuracy is always a main concern for such writings. By validated facts, we mean such facts that are mentioned in books or text books.
      Some examples of Technical Content Writings are Business Plan, White papers, Product description, User manuals, Scientific papers, and Reports of an organization.
      2-Understanding New Technology :

      As time passes, we grow in terms of newer technologies and their impacts on writings., Example on writing can be felt in writings of Origin, Da Vinci Code. We should learn and understand the newer technologies. How a journey of new innovations takes place from generation to generation and what kind of impact or burden it puts on a writer, one needs to examine. If we think or introspect, by taking any example; we will be finding that each innovations provide new terms and learning those terms, will give an edge in writings over.
      Let us examine the journey of innovations from Walk to Car and see what new words it generates during each innovations.:

      Journey of innovations. New Terms
      – walk mile, Km, furlong
      – cycle road, wheel, tyre, tube, cycle, cycling
      –bike fuel, gear, better roads,
      – car reverse gear, better roads, hand brake,
      -. train platforms, stations, rail.- lines
      – flight pilot, cabin crew, airport
      New technology needs new terms to teach/ Communicate with users and stake-holders so that effective division of labor could take place. New terms are also called new nomenclatures. We also need new rules and new policies, where also new terms gets introduced. So learning new terms is essential part of effective writing.

      3-Understanding New Terms :
      The following framework may be applied to understand a new term and thereby new technology.
      • Purpose of term – It is its definition. Understanding term starts here. Just ask what this term means.
      • Basic problem it serves / solves – By this term, what problems are being addressed.
      • And others are not solving – By this term able to solve the problem, how this is different from older terms of the same kind.
      • How it solves problem (protocols) – What are sequences and guidelines that are required for this term. Process and sequence related other terms that are connected with this term.
      • What is system? – What are requirements to build this term ? Input related other terms that are connected with this term
      • Nomenclature an instance of naming – all such type of terms can be called as nomenclature.
      • Unit analysis of concerned nomenclature – Units that is related with this term for its measurements will give idea about its nature.
      • Use distinct role analysis of the concerned industry – Wherever that term-specific industry exists, study that industry for its distinct vertical roles to comprehend the term.. Any industry, cannot have more than 10 distinct roles.

      3-Technical Content Writing :

      The technical content writing emphasis is on audience analysis and on accuracy of statements. An item or writing is given its place in technical writing, if it is validated by research. A writer may not be Subject Matter Expert (SME) and a SME may not be a good writer. There is a need of Technical Content Writer, who can balance both the roles. All the rules of Business writing are applicable on Technical Writing. However, as a technical content writer, identification of audience, knowledge of format and development of understanding of the topic are essential ingredients for him.
      The various steps are
      • 3.1 Prewriting – to find out purpose and structure framework of the writing gets extended here to include the following
      • 3.1.1 Audience Analysis : to choose a proper style of writing.
      • 3.1.2 Task Analysis :
      • 3.1.3 Understanding and translating technical information
      • 3.1.4 Development of Information structure on the lines of Description, Comparison, Classification, Cause-effect, Definition, and Persuasion
      • 3.1.5 Powerful revision technique like Hemingway App
      • 3.1.6 Referencing
      • 3.2 Drafting – Write a draft. Identify the Basic problem. Wherever necessary, use the schematic diagrams to explain the ideas. Remain focused to Basic problem. Gradual learning be resorted to. Use proper words to explain concepts. Connect with real world situations.

      • 3.3 Accurate and Validated Information Search – Books, articles, reports, websites …etc.. related with product may give good inputs. Study of Product specifications is required. Talk with Subject Matter Expert is useful. YouTube or other Videos that explains functioning or live demonstration of the product. Familiarization with similar product will give power to writing. If possible, wetting by SME, will give authenticity to the write-up
      In nutshell do
      • Audience analysis – to choose a proper style of writing.
      • Structured sentences – to maintain accuracy or validated thoughts.
      • Schematic diagrams – to elucidate the ideas and make it easily understood by others.
      • Read difficult stuff – to get acquainted with the difficult concepts and inside stories.
      • Accurate information – to stand for facts and validated information.
      • View You-Tube or explanatory videos – to understand nitty and gritty of the technical content.

      4- Understanding terms :

      4.1 Artificial Intelligence : AI

      1.Purpose
      • Purpose of term – It is its definition. Understanding term starts here. Just ask what this term means.
      > AI :
      Machine can imitate decision making abilities and instincts of humans.
      2.What it does?
      • Basic problem it serves / solves –.By this term, what problems are being addressed.
      >AI :
      Decision Making abilities of humans makes “Automation”
      3.What way it different ?
      • And others existing methods are not solving –. By this term able to solve the problem, how this is different from older terms of the same kind
      >AI :
      It can learn also from Big Data
      4.How?
      • How it solves problem (protocols) – What are sequences and guidelines that are required for this term. Process and sequence related other terms that are connected with this term.
      >AI :
      Analyzing large amount of data (Big Data)
      5. Input for AI ?
      • What is system? – What are requirements to build this term ? Input related other terms that are connected with this term
      >AI :
      Big Data analysis, Big Data is database of all kinds of data.
      6.Related terms
      • Nomenclature an instance of naming – all such type of terms can be called as nomenclature.
      >AI :
      Big Data, Data Science, Machine Learning
      7.Measuring Units
      • Unit analysis of concerned nomenclature – Units that is related with this term for its measurements will give idea about its nature.
      >AI :
      Not applicable
      8. Live Use in industry / real life uses/ “examples”
      • Use distinct role analysis of the concerned industry – Wherever that term-specific industry exists, study that industry for its distinct vertical roles to comprehend the term.. Any industry, cannot have more than 10 distinct roles
      >AI :
      Prompting salutations or sentence completion / Recommendations for you in books / pre-empting the Google Search / Voice recognition of Siri and Cortana / Self driving cars

      4.2- Internet of Things : IoT

      1.Purpose
      • Purpose of term –It is its definition. Understanding term starts here. Just ask what this term means.
      > IoT :
      Automation of things through internet
      2.What? It does?
      • Basic problem it serves / solves –. By this term, what problems are being addressed. >IoT :
      It does automation or control by mobile app. Sensors of things communicates via internet through server / cloud to a mobile app / website and app then communicates with sensors of things again via internet leading to automation.
      3.What different way it serves ?
      • And others are not solving –.
      >IoT :
      By this term able to solve the problem, how this is different from older terms of the same kind Sensors messaging through Internet. Internet / wifi is the different way.
      4.How?
      • How it solves problem (protocols) – What are sequences and guidelines that are required for this term. Process and sequence related other terms that are connected with this term.
      >IoT :
      Sensors of things communicates via internet through server / cloud to a mobile app / website and app then communicates with sensors of things again via internet leading to automation.
      5. Input for ?
      • What is system? – What are requirements to build this term ? Input related other terms that are connected with this term
      >IoT :
      Signals from sensors fitted in the things to be controlled and controlling units.
      6.Related terms
      • Nomenclature an instance of naming – all such type of terms can be called as nomenclature.
      >IoT :
      Big Data, Machine Learning, Sensors, Devices,
      7.Measuring Units
      • Unit analysis of concerned nomenclature – Units that is related with this term for its measurements will give idea about its nature.
      >IoT :
      3G, 4G, 5G, Broadband, Wifi, Mobile data
      8. Live Use in industry / real life uses / examples
      • Use distinct role analysis of the concerned industry – Wherever that term-specific industry exists, study that industry for its distinct vertical roles to comprehend the term. Any industry, cannot have more than 10 distinct roles
      >IoT :
      Alexa, smart watches, video doorbells, light systems, Smart homes, Smart Cities.

      5- Some General Technical Topics :
      5.1 AI, Big Data, Machine Learning – Forbes.Com
      5.2 Blockchain and Crypto – CoinDesk
      5.3 Mobile and Web Applications
      5.4 Cloud Computing
      5.5 ERP, CRM and Payroll and other Business Applications
      5.6 Automation Technology
      5.7 AI in Specialized fields – Legal, Finance, and Accounting, etc…

    • #6681
      Anushri SaxenaAnushri Saxena
      Participant
      @asaxena

      Technical Writing:

      Everything in this world has a technical aspect even as simple as the feeling of love. The term technical indicates something that is not widespread or known to many. When we thoroughly study about something, we become an expert or SME in that area. Technical communication happens between an expert and a layman. In technical writing, a writer is an expert and the reader is a learner. Common forms of technical content include Business plans, white papers, product descriptions, user manuals, science papers, reports, etc.

      It is very important that a technical writer explains the topic as per the reader’s knowledge. For ex: description of a residential property would vary as per the audience. For an engineer/architect, the explanation will be based on the raw materials used, compliance, sanitation, and design. For a commoner, it will be based on the area, no. of rooms, location, security, surrounding amenities etc. In technical writing, the audience plays the center stage.

      The technical writer focuses on the facts and precludes himself from any opinions or preconceived notions. He uses a neutral style of writing. Since it is based on facts, accuracy is paramount.

      There is a myth in the market that writers with a technical background can only attempt technical writing. This is not completely accurate. Even a creative writer can excel in technical writing. The approach is to get rid of the mental block, fear of math and science and master research skills.

      Not only people with technical acumen, but anybody can understand any technology to an expert level. Any new invention is the solution to an ongoing problem. The process/questions to understand any technology is listed below:

      1. Which basic problem is new technology solving?
      2. How it solves the problem (process/method involved)?
      3. What all systems (equipment/machines) are applied?
      4. What are the nomenclature/terms coined to familiarize with the technology?
      5. What kind of designation/profile/expertise incorporated in the line of work where the technology is practiced?
      6. Some case studies/real-life examples.

      All the rules of business writing are applicable in technical writing too, however, technical writing could be slightly elaborative.
      To answer the above questions, we should have a proper pool of information to dig deep to understand the technology thoroughly. Below is the repository of knowledge:
      1. Books, articles, reports, websites related to the product
      2. Product specifications
      3. Interviews with the subject matter experts- product specialists, developers, engineers
      4. Product meetings during the development cycle
      5. Live demonstrations videos
      6. Researching similar, competing products
      7. Experimenting with working models of the product
      8. Most importantly, SME’s review for technical accuracy

Viewing 6 reply threads
  • You must be logged in to reply to this topic.
Open chat
Chat with Us
Hello, can you please tell us your Name, email, and the course you are interested in so that we can help you quickly.
Powered by