Tuesday, 14 February 2012
Technical Report Writing Format
technical report writing format
technical report writing format
technical report writing format
Wednesday, 14 December 2011
Report Writing Sample Format
report writing sample format
report writing sample format
report writing sample format
Saturday, 26 December 2009
Technical Report Writing Format
Simplified format for scientific research proposal and project writing
Overview
Research since time immemorial has being the foundation for intervention in science and other field of study where an issues are discussed using a systematic format in arriving at ideas that will give a fair knowledge about these issues. To enable an orderly way of carrying out research, seeking for funding, bringing an issue on board for discussion and future referral purposes, research has adopted a methodological approach of investigating into problems, to either agree or disagree with scientific hypothesis and as well recommend if any. This write-up is intended to highlight the important features in every proposals and address the problem with as several researchers (scientists) and students who are faced with a problem of finding a cross-sectional format for writing a scientific research proposal and project, this paper does not however provide all specific requirements of various organisations, departments, institutions and individuals, rather a generalized format. When seeking for funding and admission from such organisations, departments, institutions and individuals, their specific requirements should be considered. This paper seeks to achieve the following two objectives;
- To address the difficulty scientist/students' face in following the exact format for scientific research proposal and project. Thus, the items to look at are topic phraseology, the introduction (which includes the background to the study, definition of the problem, rationale and objectives or aims of the study), research hypotheses/questions, literature review, definition of terms, research design, methodology and methods of analysis, result analysis and discussion, conclusion and recommendation, reference and appendix.
- To address the issue of meeting technical requirements such as writing style, citation and referencing
A Scientific research proposal is a written document by a researcher declaring his/her intention to undertake the research project which will add knowledge to science. It helps the researcher to conceptualize issues, systematically plan and follow a road map before the actual work. Language used in proposal are in future tenses because it is not yet carried out (it's a future activity)
A scientific research project is a practically executed and written document which arrives at the aim and specific objectives of the proposal. This is the real work done and passive language is used since the research has been carried out, however, theory (proposal) may not really be case in practice (project). The reporting of the actual work and associated result analysis and discussion is the project work. The proposal may only a preliminary road map for the project, this is because changes may be required to make research project very feasible during the execution process.
The following features are generally requirement in research proposal and project;
.
1.0 Topic:
State your research topic in a clear and concise manner. Drafting of good research topic is a very important marketing tool as it clearly sells out the idea(s) the researcher is intending to deliver to his readers. The topic should catch the sight and interest of most readers as you systematically debate your case convincingly which will at the end disagree-to-agree, agree-to-disagree or agree-to-agree with your hypothesis or existing knowledge, and provide recommendations for the future researches. Make sure you can easily identify the variables of interest. Usually, the topic should not be more than fifteen words. Researchers/students are advised to avoid ambiguous topic that will not create a reading interest, this makes the work lose it real value since.
2.1 Introduction
Usually the introduction to the research begins with the background of the study.
2.11 Background of the study
The background information covers the general ideas on the topic you are about to work on; this opens up the readers mind about whole research. Definition and explaining of terminologies and the topic is expected in this section, this will place the ordinary man on an average level to enable he/her understand the research. It places your work in a theoretical context, and enables readers to understand and appreciate your objectives.
Describe or examine the topic in its scientific context capturing statistical implications, impact on society and progress. Previous related studies about the topic (literature) from books, journals, thesis and dissertations, public reports, conference reports and proceedings are required to know the up-to-date state of the research topic, this makes readers know how familiar you are with the current literature and how well you understand issues and constraints involved in conducting research in the area.
It summarises the current knowledge in the field and making it clearer, which previous work was done by others (and which by you if any).
2.12 Problem Statement
Describe the situation that exists and the situation that is expected. Identity the gap, question or problem that necessitates the study, this should explain what gaps in the literature will be filled by your research project. Show how the proposed work will further that knowledge in research. The problem statement should be clearly stated and explained in a manner that will let readers see the need for the study. State the core problem; the possible factors that influence the core relationships among factors and attempt a solution.
2.13 Rationale/ Significance/ Justification for the study
Explain and demonstration how the knowledge that will be obtained from this study will have impact on science and its related applications. The importance and application(s) must be demonstrated to the readers; the study is necessary and shall contribute to knowledge or fill a gap in the literature as well as for its practical application. You answer the question how and why is this study necessary?
2.14 Objectives
State the importance of the research, the objective must be phrased clearly in operationally realistic terms following logically solving different aspects of the problem. Use action verbs; To address, To calculate, To establish, To examine, To describe, To determine, To compare, To identify ,To assess, To analyze etc.
Passive verbs like: To study; to understand; to find out, etc should be avoided. The objective may be put into two categories:
- • General/Broad objective
The general objective (aim) is the ultimate goal (overall) expected to be achieved at the end of the study. This is the anticipated outcome attained after systematically analyzing the outputs (specific objectives) of several activities performed within the whole study that are geared at solving the problem.
- • Specific objectives
While the specific objectives are the anticipated outputs of the respective specific activities intended to be carried out during the study in order to achieve the general objective (aim). In other words, specific objectives are result-oriented activities of broken but connected parts of the general objective. The overall analytical sum of these specific objectives that will be achieved through several experimental activities form the general objective.
2.15 Research Questions/Research Hypotheses
Usually after the literature review, the research Question/Hypotheses can come even though it is also accepted when it appears after the literature review. Research Questions (RQs) and the research problems are similar but the difference there is a degree of specificity attached to RQs while the research problem is more general. In the RQs the variables have been labeled more specifically. You use the research questions when information about the variable is not sufficient, when exploring the variables and their relationships and when you use populations and not samples.
There are three types of research questions:
Exploratory Questions- e.g., are parent irresponsibility for children associated with teenage pregnancy? Can high mortality of HIV/ AIDS patients be attributed to the stigmatization of the disease?
Descriptive Questions-e.g., Have children from broken homes more sound mind than those in more endowed and responsible homes? Do the lives of HIV/ AIDS patients on antiretroviral drug live longer than those who are not?
Explanatory Questions- e.g., Will students' academic performance improve when the Teaching Staff's take home pay increases. Will price of commodities be stable if there is political stability?
On the other hand, the hypothesis is a written statement of the working hypothesis (i.e. directional-one tailed) and not null hypothesis that is stated. The hypotheses should have a theoretical basis and are derived from the literature review. You use the hypothesis when there is sufficient information about the variables understudy, when using samples not populations, when you select a probability level prior to data collection and when you use hypothesis testing procedures. Stating Hypotheses
Examples:
- • Inadequate learning materials cause poor academic performance.
- • Education is positively related to development.
Definition of terms: Define the terms/factors/parameters/variable you will use in the research. Not dictionary definitions but definitions peculiar to the present study with scientific principles and operation.
3.0 Literature Review
Previous relevant studies conducted by other authors in the same or related field must be reviewed to support and assure readers that you have current and previous knowledge on the topic if your work is based on a theory or theories. In other words, research evidence or findings that support or refute the theory or theories must be considered, however, students are encouraged to review most recent works. Students are advised to paraphrase referential main ideas, principles and methodological approach of the current and previous works. Avoid "cut and paste" of these works plagiarism.
4.0 Research Materials and Methodology
List the materials that will be employed in the research to obtain the result. Provide more explanation of the rationale (why the approach and not other chosen) and should be well documented using reference where possible to support choices. Use sub-headings as needed to help readers to keep track of the basic component. Define the population and describe its demographic characteristics; state study timing, sampling procedures (sample size and technique). Ethical issues addressing the authorization, risk and benefits of the research should be clearly explained for readers and participants.
Data collection or research instruments (mention a number of items and how they are scored) that are required must be mentioned.
Most scientific research usually involves field and laboratory works, clearly explain the various methods (experimental tests) that will be applied to the collected sample or data to obtain the results. Add reliability and validity levels if they are standardized tests. Also identify and describe the design, whether it is a Descriptive study, Correlation study, Case study, Experimental/Cause and Effect study, Comparative study, Longitudinal Study, Cross-sectional study etc (justify choice of design-tell your audience why you used a particular design); questionnaire/interview administration procedures including pilot study and ethical assurance. Include methods that will be used to manage and analyze the data that will be gathered from the study.
NOTE
- After material and methodology, the list of reference and appendix will follow to make it up for the whole research proposal.
- The above features are usually general for many proposals, however different individuals and institutions may require little additions (some may include time table, budget, etc) or subtraction.
- Proposal language is usually in future tenses will, some few technical changes may be made during the execution of the real work while the project in past tenses.
- After carrying out the project, the reporting of the research work will feature the under-discussed headings
5.0 Results and Discussion: Obtaining the results when the actual project is executed, results must be vividly presented in an orderly manner for easy analysis. Statistical analysis of the results or data is pertinent for thorough discussion and interpretations to enable you answer the research questions. This component usually features importantly in the project write-up (report) with past tense as it style of writing. Use statistical (Quantitative and qualitative analysis) tools; discuss the specific objective mentioned earlier while gearing towards the ultimate goal (general objective). You may statistical (descriptive) represent your result using frequencies, ratios, proportions, scatter diagram, pie chart, and bar chart, measures of central tendency (mean, median, and mode), percentages, percentiles, quartiles and cross tabulation. Various statistical tools are employed here to analyze results and inject meaning into the data.
However if you are using Inferential statistics (parametric and non parametric tests) you will have to consider the following: simple correlation, regression analysis, t-test, ANOVA, Chi-square etc. Use statistical packages like statistical package for social sciences (SPSS) and others to run the analysis. Make sure you are familiar with the statistical method you choose. Let your audience know the expected outcome of the research.
For qualitative analysis major findings are derived from interviews and related to previous literature. Similarly, discussion of findings after statistical analysis under quantitative is done in relation to previous literature.
6.0 Conclusion and Recommendation: This part should tell the readers the meaning of findings of the research conducted; it explains how the general objective is achieved through the various specific objectives. It agrees or disagrees with the hypothesis that was stated earlier. Vividly state the impact of the research on the society or target group. Briefly demonstrate how the research fills gap(s) in science.
The recommendations include the limitations of the research, setbacks encountered during the research and further findings the research may require.
7.0 References (Must be written in the American Psychological Association
(APA) style): This is list of source of information published in journals, website, books, conferences, magazines and seminars used in the write up have been duly acknowledged. Any work cited in the main write –up should be acknowledged under the heading references/Bibliography. Student are increasingly using the www.com as main reference, however it is not done the correct way. The student have to show the name of the author , date , source and add that the information was retrieved on such date from the world wide web. Examples are provided below to guide students.
Web Reference
Arul, M.J. (2003) Interpersonal Needs of Managers and Management Students: An Exploratory study. A synopsis of Doctoral Dissertation. Retrieved September 6, 2005 from the World Wide Web: http://www.geocities.com/Athens/5503/synopsis.html
Journal Reference
Simpeh, K.A. (2007) Correlates of Sustainable Cottage Industries in Ghana, African Development Journal, 2, 1: 10-17.
Book Reference
Raymond, A.N. (2005) Employee training and Development. New York: McGraw-Hill Irwin an Article from a Book
Opoku, J.Y. (1992).The influence of semantic cues in learning among bilinguals at different Levels of proficiency in English. In R.J.Harris(ed).Cognitive processing in bilinguals. Amsterdam; North-Holland/Elsevier Science Publishers, Pp.175-189
1.12APPEDIX
This is list of step-by-step activities, tables, figure, glossary etc.
Technical advice to students
Organization of the study: This should be presentedin essay form not points. The study is normally organized into five major chapters: Introduction; Literature review; Research materials and methodology; Results and Discussion; Summary of findings, conclusions and recommendations/Implications.
Your writing style should be impersonal and in the future tense
Don't use "I"
Example: I will interview participants-Wrong way
Participant will be interviewed (note the tense is in the future)-right way.
Headings
• Flush all headings to the left margin
• Chapter /Section headings-must be in upper case
• Subheadings-title case with lower case
• Sub-subheadings-sentence case with extra line space above
Example: 1. 0 MAIN HEADING
1.1 Subheading
1.11 sub-subheadings
Time Table: Keep a workable time table to complete your work. Revise it if you need to, there is nothing wrong about that.
Edit your work well before you send it out to readers.
About the Author
Authors: David Ngmenterebo and Oliver Awo
David Ngmenterebo
Email: datiereka@yahoo.com
Tel: +233243296528
Oliver Awo
Email: awooliver@yahoo.com
Tel: +233246799890
An Introduction to SQLite
technical report writing format
technical report writing format
Friday, 25 September 2009
Sample Technical Report Writing
How to write a equity research report?
I interviewed an investment bank for a junior equity research position. They let me write a sample equity research report. I have relatively strong technical beckground, but don't have MBA or CFA and only have limited financial knowledge. How can I write an effective equity research report? What should I prepare in such a short time? Thanks in advance!
I suggest you read other equity research reports to determine what is considered important. Try to get research reports in related companies to see what is considered more important. (For example, the new product pipeline is important for drug companies, while same store sales is important for large retail chains.)
CS & IT Symposium 2010: Web Design and Development - A Key to a Growing Program
sample technical report writing
sample technical report writing
sample technical report writing
Thursday, 12 February 2009
Sample Technical Report Writing
Business Analyst Sample Resume for Pharmaceutical Industry
Sample Business Analyst resume for Pharmaceutical Industry.
Professional Synopsis
Nearly XX years experience as a Business Analysis, Risk Analysis and Quality Assurance. Expert in obtaining a grasp of the business process and acting as a bridge between the Management and the Development teams. Strong customer/user advocate, apt negotiator with excellent analytical, collaboration, communication decision-making, and organization skills. Good communication skills coupled with excellent interpersonal skills that helped in developing an excellent rapport with the team members and maintained an inspiring environment, which I strongly believe, play a key role in carrying out the given tasks within the time constraints.
Professional Expertise:
Business Analysis knowledge for business process, the need to understand all aspects of the company's operations. Identify, analyze and design processes to improve the overall flow of information within the company
Interacting with stakeholders, gathering requirements, elicitation techniques like interviewing, questionnaires, brainstorming, focus groups, cost/benefit analysis and risk analysis- Excellent knowledge of Software Development Life Cycle (SDLC), Iterative Software Development Life Cycle Process as per Rational Unified Process (RUP) and Rational Tools used during various phases of RUP.
- Proficient in Rational tools including Rational Rose, and Requisite Pro. Excellentskillsin Business Analysis, Data Analysis, Requirement Analysis, Business Process Modeling and Use Case Development using UML methodology.
- Skilled in creating logical diagrams like Use Case, Activity, Sequence, Data flow, Collaboration and Deployment using CASE Tools like Rational Rose and MS Visio.
- Experience in conducting Joint Application Development (JAD) JAD sessions with management, SME, vendors, users and other stakeholders to gather business requirements and translating the same to the development teams.
· Performed Functional, Integration, Data Validation, User Acceptance, and End-To-End testing and evaluated the test results. · Expertise in automating the functional and performance test scripts using industry standard like Winrunner, Rational Robot and QTP.
Technical Proficiency:
Business Modeling Tools
Rational Rose, MS Project, MS Visio
Change Management Tools
Rational Clear Case, Clear Quest, TestDirector
Languages
C, C++,SQL, PL/SQL, JAVA, VB
Operating Systems
MS Windows NT/98/95/2000, Unix
Web Technology
HTML, DHTML, ASP, HTTP, JavaScript
Database
SQL Server, Oracle, Sybase, MS Access, MySQL
Utility
MS Office, Virtual UML, FrontPage
Automation tools
Rational Analyst Suite, RUP, RequisitePro and Rose.
Mercury Interactive WinRunner, Load Runner, TestDirector, QTP.
For more BA Questions, Sample Resumes and Open Jobs – please visit: http://www.allarticleslist.com
Company name duration
Sr. Business Analyst / Technical Writer
CTS are data collection environments that provide utilities to collect drug and vaccine data and to convert data from our collection systems to the back-end reporting and filing databases. Collector allows investigative sites to collect cleaner data faster, by alerting users to discrepancies at the time of entry and by electronically transmitting study data to reviewers. Browser allows remote study monitors to review and annotate collected data on a regular basis, to set workflow statuses, and to transmit queries back to the investigative site when necessary.
- Responsible for defining the scope of the project, gathering business requirements, doing gap analysis and documents them textually or within models.
- Responsible for writing Functional Requirement Specifications (FRS) and User Requirement Specification (URS) for the Web based application.
- Understand and articulate business requirements from user interviews and then convert requirements into technical specifications.
Interviewing area experts, asking detailed questions and carefully recording the requirements in a format that can be reviewed and understood by both business people and technical people.- User Rational Rose extensively to created Use Cases, Activity Diagrams, Sequence Diagrams, State chart diagrams, Collaboration diagrams and Class Diagrams.
- Extensively used UML based Methodology to create the Business Object Model.
- Worked on CFR Part 11 validated and Regulated System.
- Worked as a UserCustomer Advocate and negotiated with user as well as with developers and management staff to resolve any requirement conflict to BRIDGE the gaps between IT and Business Client.
- Served as quality assurance/quality control to ensure that the final product met all the clinical protocol requirements. Was responsible for user acceptance testing (UAT) of the final product.
- As a liaison between the Developers and Clients, was instrumental in resolving conflicts between user and technical development teams.
- Designing and reviewing different comprehensive data reports using MS Access and MS Excel.
- Involved in Project Management including documenting, implementation throughout the collector development lifecycle.
Environment: J2EE, JSP, Oracle Clinical, CSS, cGMP, FDA Regulations, Windows NT, MS Office (MS Access, MS Excel), Rational Rose, Requisite Pro
Company name duration
Business Analyst
Worked in Clinical trial system; this is an application used to collect the patient data who is taking part in the new study for a drug/vaccine. This is a CFR Part 11 validated and Regulated System.
Responsibilities:
Identified and validated high potential business opportunities for stakeholders and develop customized business strategies that are aligned with corporate strategic objectives.- Interviewing business area experts, asking detailed questions and carefully recording the requirements in a format that can be reviewed and understood by both business people and technical people.
- Conducted JAD Sessions to develop an architectural solution that the application meets the business requirements, resolve open issues, and change requests
- Prepared Business Process Models that includes modeling of all the activities of business from conceptual to procedural level.
- Followed the UML based methodsusing Rational Rose and Visio to create Use Cases, Activity Diagrams/State Chart Diagrams, Sequence Diagrams, Collaboration Diagrams
- Assuring that all validation documentation such as IQ's, PQ's, Process Validation, Cleaning Validation, and Software Validation are in compliance with cGMP's.
- Wrote documentation for all aspects of the computer systems validation lifecycle, in accordance with FDA regulations, particularly CFR 21, part 11. Validating processes and equipment utilized to manufacture active pharmaceutical ingredients in FDA environment.
- Performed Unit and System testing, before integrating all the separate modules for further testing to assure an efficient operation.
· Involved in weekly walkthroughs, inspections and verification meetings with various stakeholders in the project. · Conducted periodic Software Quality Assessment meetings to come up with test metrics and gauge the progress of the testing effort.
Environment: Java, JSP, Oracle Clinical, CSS, cGMP, FDA Regulations, Windows NT, MS Office (MS Excel for reporting), Rational Rose, Requisite Pro
Company name duration Business Analyst
--- Pharmaceuticals is developing next generation anti-infective compounds to meet the growing need for effective treatments for tenacious and drug resistant strains of bacteria.
Tassa's advantage stems from its unique blend of expertise in comparative genomics, molecular pharmacology, combinatorial chemistry and physiological ecology.
- Responsible for defining the scope, and defining business rules of the project, gathering business requirements, doing gap analysis and documents them textually or within models.
- Responsible for writing Functional Requirement Specifications (FRS) and User Requirement Specification (URS).
- Understand and articulate business requirements from user interviews, and workshops and then convert requirements into technical specifications.
- Conducted and coordinated JAD session with different technical teams.
- Served as a liaison between Clients and Technical Staff to resolve any conflicts.
- Worked to BRIDGE the gaps between IT and Business Client.
- Analyze Business Requirements, performed GAP ANALYSIS and segregated them into high level and low level Use Cases, Activity Diagrams / State Chart Diagrams and Robustness Diagram using Rational Rose according to UML methodology thus defining the Data Process Models.
- Followed the UML based methods using Rational Rose to create: Use Cases, Activity Diagrams / State Chart Diagrams, Sequence Diagrams, Collaboration Diagrams.
- Involved in maintaining and managing different versions of Documents using Rational ClearCase.
- Involved in preparing Test Plans based on User Requirements Document (URD) and prepared the Test Cases and Test Procedures.
- Tested the application Manually by executing Test Cases prior to Automation.
- Actively involved in User Acceptance Testing and Training of the end users.
- Prepared Logical Data Models that contains set of diagrams and supporting documents containing the essential business elements, detailed definitions, and descriptions of the relationships between the data elements to analyze and document business data requirements.
- Using Business Rules, Business Use-Case Model and Business Object Model participated in Requirement Analysis of the application and performed GAP analysis.
- Conducted the FRS and URS reviews and walkthroughs with designers, developers and stakeholders. Also conducted feasibility and adaptability study.
- Used Rational RequisitePro for Managing the Requirement Analysis effort.
Environment: Windows 2000, Java, JSP, Oracle Clinical, SQL, Oracle, cGMP, Rational Rose, Rational Requisite Pro, UML, and Proprietary protocols.
For more BA Questions, Sample Resumes and Open Jobs – please visit: http://www.allarticleslist.com
About the Author
Find many BA Interview Questions, Ask Interview Questions and get expert answers, Find many Sample resumes or Request one professionally written for you for FREE : please visit: http://crackinterviews.com/blog/
*Business Growth Plan* for "Trade Contractors"
sample technical report writing
sample technical report writing