Browse complete writing, composition, rhetoric and technical-writing series from the local English Wikibooks and Wikiversity canonical dumps. Every detail retains its source revision and full cleaned native sections; media is deliberately excluded.
Each page belongs to a named source series. Redirects, template-only pages and pages below the 500-character native-text threshold are excluded from independent details. Source links are secondary revision and attribution references, not the main reading path.
Back to Writing Requirements and Functional Specifications(EE) back to Technical Writing at Wikiversity It is difficult to obtain information from a Customer. Customers often reply before they have all the information required. Customers do not want to appear to be stupid so they quickly reply…
Back to Writing Requirements and Functional Specifications(EE) Availability is the percentage of time that the system must operate without failure Example A telephone exchange must operate 99.9997% of the time. 100% Availability is unachievable) A Functional Requirement describes the functions a…
How to edit Wiki Wikiversity Main Page back to Technical Writing Level 1 __TOC__ Generally speaking, there are a limited number of approaches to getting cooperation and information from specialists: Subject Matter Experts (SMEs) have information. Your job as a technical writer is to transfer that…
How to edit Wiki Wikiversity Main Page back to Technical Writing Level 1 __TOC__ There are a limited number of opportunities to get cooperation and information from experts: The experts are people who have the best information about the product, but the experts are the busiest people on the…
back to Technical Writing Level 1 --Chatsami (discuss • contribs) 00:07, 13 November 2014 (UTC)=The Systems Development Life Cycle= The Systems Development Life Cycle (SDLC) is a logical process that helps to design good new products and software efficiently. The SDLC system emphasises planning.…
__NOTOC__ A requirements specification is never really done. It is an iterative document that reflects the plans and intentions of the development team. As those change, so must the specification change. It's a living record of what you are doing. Still, you can check the quality of your…
Structure Must have a tubular frame Will have 4 legs Will have arm rests (plastic) Must have a back rest (fabric) Must have a seat (fabric) Will use nuts & bolts for connecting components Will have feet for legs Use The chair must hold a user when they sit on it The chair must be sturdy enough to…
The perils inherent in ignoring users while developing a product are as obvious as they are prevalent. Only a very few software projects consciously involve end users throughout the whole process. So almost every project is plagued with misunderstandings, slow communications, unclear requirements,…
back to Technical Writing Level 1 TWFred speaking on Levels of Detail (YouTube Video) An information "chunk" is a digestible unit of information. When creating descriptions or instructions, a document structure will always be composed of a number of information chunks. A telephone number, for…
* back to Technical Writing Level 1 Structure describes how a thing is built (the architecture). Function describes what a thing does. We can describe the structure and functions of everything Figure 1-1 A Kettle *This kettle is made out of metal (structure) *This kettle boils water (function) A…
Back to Technical Writing Level 1 Wikiversity Main Page Contributor: Susan Flander Williams Technical Writing Videos Free short videos are available from (an author of Technical Writing Course) explaining technical writing strategies and techniques. These videos complement the contents of this…
Back to Requirements Analysis Joe was born in the United Kingdom but spent most of his childhood in Vancouver, Canada. At university he studied English literature and decided to spend a year teaching English as a foreign language, and did a 4 week training course straight after university. Now 28…
back to Technical Writing Level 2 This Technical Writing course focuses on methods and processes that are tool-independent. Organizing writing, editing, and graphics in a usable manner is your primary task and is essential to the user experience. The primary tools a technical writer needs are:…
How to edit Wiki Wikiversity Main Page __TOC__ Tables are an excellent way to organize large amounts of information in an easy to read way. The following code will build a basic table. Tables always begin with In the first line we set the widths of the borders and the space between cells.…
Back to Tools Tables are a very easy way of organising information. All tables begin with . The most common markup used is known as the "pipe" - which looks like this . The following code will build a basic table. In the first line we set the widths of the borders and the space between cells.…
back to Technical Writing Level 2 __TOC__ Generally, documentation is divided into two main areas. * Process Documentation guides the development, testing, maintenance and improvement of systems. They are used by managers, engineers, testers, and marketing professionals. These documents use…
* back to Technical Writing Level 2 * back to User interfaces Choosing the right colors to use is a very important aspect of User Interface (UI) design. Choosing a color palette that makes it easier for the user to distinguish content is essential. Avoid using disturbing colors and try to keep the…
* back to Technical Writing Level 1 Writing clearly quickly communicates information to the people who need it. *Write in simple sentences. *Use words that the readers understand. *Explain what the reader does not know but do not waste the reader's time by explaining concepts that they already…
By following the approach of essay writing outlined in this book, you can avoid a whole range of very common essay problems: # Unstructured: Many essays are not structured, which makes them difficult for the markers to read. Without structure, reading an essay is like a discovery journey: your…
Having written the essay, you state that you have done so. This section is often separated visually, or singled out with a subheading such as conclusion or concluding remarks. What this section does, is summarizing what you have done, and providing a conclusion to the argument. Never should you…
Having decided what to include in the answer, there is another way to make sure the answer is focused: telling the reader what we are talking about. By defining what the key terms mean, we do two things. Firstly, we show that we know what we are writing about. Secondly, we avoid misunderstandings…
First of all, it’s necessary to state to the reader how you understand the question. Not only raises this expectations, but also can you demonstrate that you’re focused. Furthermore, you’ll avoid that your reader will misunderstand you, or think that you have left out critical aspects. For example,…
After presenting the main argument, it’s usually necessary to discuss what this all means. The argument of the essay may have implications on policy, implications on the use of certain theories, or implications on how we (should) understand the world. Not always are these implications novel or big.…
Exam essays are essays like others. They differ mostly by the constraints of time and therefore space. For these reasons, it’s even more important to follow a clearly structured approach to writing. The time constraints mean that you need to remain very focused in order to make most of what is…
The following is a glossary of some of the technical words used in this book. Body: The main part of your essay is sometimes called the body. It’s the essay minus the introduction and conclusion. Citation: A citation is a reference to the work of somebody else. You put a citation whenever you use…
This small book aims to be a practical guide to essay writing. A generic approach to writing is introduced, enabling you to write in a clear and structured way, while at the same time allowing you to develop your own argument in a creative way. A good essay combines your own content with a clear…
This part constitutes the main part of your essay. Try to use about 60% of your words for this part. You can understand it as delivering what you have promised in the introduction. This part of the essay is often referred to as the main body, or the argument. It’s the part of the essay, where you…
This is a fresh and approachable guide helping students to write better essays at university. It addresses students directly and is packed with practical information. Examples from real essays are included to make the text more approachable. This book is an attempt to help students write better…
On this page you find a list of process words that are often used. This list is in part based on Jordan (1999). The process words are given in alphabetical order. Probably the most common process words are: discuss, describe, explain, compare, evaluate, and criticize. Account for asks for an…
Allen, J. & Massey, D. (eds) (1995) Geographical Worlds, Oxford, Oxford University Press. Almeder, C., Caulkins, J., Feichtinger, G. & Tragler G. (2001) ‘Age-specific multistage drug initiation models: Insight from considering heterogeneity’, Bulletin on Narcotics, 53(1&2):105–18. Blankenhorn, D.…
