Technical writing
Dr. Manish T I @ CSE, ASIET
Overview
● Technical writing - Journal Articles
● To publish the results of ongoing or completed work.
● It is not just about getting recognition.
● Publication is a critical step in the scientific process.
Process
Experiments or
Simulation
Results Communicate
Journal
Experts or
Reviewers
Recommandations
Publishing H/S
Why publishing in Journals
❖ Others researchers can look and work forward.
❖ Prior journals article will justify your work .
❖ One of the metric used to measure the degree of research.
❖ Credits for your work done.
❖ Conveying important new information.
Difficult to Publish ?
Inform the purpose and persuade the reader of
the journal with technical evidences.
Beginning
Title - Area of Research + What’s New
Abstract - Give away all the important results (findings) of your work.
Introduction - What exactly is your work, why it is important, Prerequisite required
to understand
The development of your manuscript will begin long before you begin to actually
write your first draft.
You should not write just for the sake of publishing or to accumulate citations for
your curriculum vitae. if you do, surviving peer review will be a challenge.
As you plan your research project, think about how your work will be received and
evaluated by your peers.
Questions
Is this data collected and analyzed of interest to the wider community?
What has been done in the past?
Does this research significantly advance the state of the field?
To answer these questions, you need a solid understanding of the relevant literature.
Literature Search
Your research problem must contribute new and important knowledge to your
field.
A thorough review of the published literature will help you to show reviewers
and readers that you understand what work has been done before, and that
your research adds some new understanding or value to the field.
Finally, a thorough review of the literature will help you select the publication
or conference to which you will submit your work.
Research Publications
● Institute of Electrical and Electronics Engineers IEEE
● Springer
● Elsevier
● Taylor & Francis
● Directory of Open Access Journals (DOAJ)
● Institution of Engineering and Technology IET
● The Institution of Electronics and Telecommunication Engineers IETE
● Industry white papers
Middle & End
Discussion or Implementation - Straight forward languages is used with flowchart
Try to convey the concepts in small sentence
Experimental Details - Better to represent in Table, Graph, Figure.
Results - Even though we have disclosed the finding in the abstract.
The details of the experimental results can be discussed with future scope.
References & Citations
Once you identify a major document that is relevant to your research, check the
references.
They will lead you to the research that laid the basis for your area of study.
Use tools available in platforms such as IEEE Xplore to save searches documents
you have identified.
https://ieeexplore.ieee.org/document/6327260/citations
Reading & Keeping Track on Notes
As you search, scan the abstracts and keywords.
There is no need to read through every document.
For each reference you want to include in your bibliography, make note of the
original publication source
Ethics
● Who is an Author
Develop a list of authors that includes a description of each person’s contribution to
the project and the writing of the manuscript, then document the reasons for any
additions or deletions of authors along the way
● Proper citation of original work
● Plagiarism
● Redundant Publication
References
● The Craft of Scientific Writing by Michael Alley, Springer-Verlag New York
● How to write for Technical Periodicals & conferences @ IEEE
● Technical Writing by Prof. Haridoss @ IITM

Technical writing

  • 1.
  • 2.
    Overview ● Technical writing- Journal Articles ● To publish the results of ongoing or completed work. ● It is not just about getting recognition. ● Publication is a critical step in the scientific process.
  • 3.
  • 4.
    Why publishing inJournals ❖ Others researchers can look and work forward. ❖ Prior journals article will justify your work . ❖ One of the metric used to measure the degree of research. ❖ Credits for your work done. ❖ Conveying important new information.
  • 5.
    Difficult to Publish? Inform the purpose and persuade the reader of the journal with technical evidences.
  • 6.
    Beginning Title - Areaof Research + What’s New Abstract - Give away all the important results (findings) of your work. Introduction - What exactly is your work, why it is important, Prerequisite required to understand
  • 7.
    The development ofyour manuscript will begin long before you begin to actually write your first draft. You should not write just for the sake of publishing or to accumulate citations for your curriculum vitae. if you do, surviving peer review will be a challenge. As you plan your research project, think about how your work will be received and evaluated by your peers.
  • 8.
    Questions Is this datacollected and analyzed of interest to the wider community? What has been done in the past? Does this research significantly advance the state of the field? To answer these questions, you need a solid understanding of the relevant literature.
  • 9.
    Literature Search Your researchproblem must contribute new and important knowledge to your field. A thorough review of the published literature will help you to show reviewers and readers that you understand what work has been done before, and that your research adds some new understanding or value to the field. Finally, a thorough review of the literature will help you select the publication or conference to which you will submit your work.
  • 10.
    Research Publications ● Instituteof Electrical and Electronics Engineers IEEE ● Springer ● Elsevier ● Taylor & Francis ● Directory of Open Access Journals (DOAJ) ● Institution of Engineering and Technology IET ● The Institution of Electronics and Telecommunication Engineers IETE ● Industry white papers
  • 11.
    Middle & End Discussionor Implementation - Straight forward languages is used with flowchart Try to convey the concepts in small sentence Experimental Details - Better to represent in Table, Graph, Figure. Results - Even though we have disclosed the finding in the abstract. The details of the experimental results can be discussed with future scope.
  • 12.
    References & Citations Onceyou identify a major document that is relevant to your research, check the references. They will lead you to the research that laid the basis for your area of study. Use tools available in platforms such as IEEE Xplore to save searches documents you have identified. https://ieeexplore.ieee.org/document/6327260/citations
  • 13.
    Reading & KeepingTrack on Notes As you search, scan the abstracts and keywords. There is no need to read through every document. For each reference you want to include in your bibliography, make note of the original publication source
  • 14.
    Ethics ● Who isan Author Develop a list of authors that includes a description of each person’s contribution to the project and the writing of the manuscript, then document the reasons for any additions or deletions of authors along the way ● Proper citation of original work ● Plagiarism ● Redundant Publication
  • 15.
    References ● The Craftof Scientific Writing by Michael Alley, Springer-Verlag New York ● How to write for Technical Periodicals & conferences @ IEEE ● Technical Writing by Prof. Haridoss @ IITM