added new topics

content/post/intro.md

@@ -5,9 +5,87 @@ date = "2022-09-10"
 description = "This is a technical writing introduction"
 +++
 
-# introduction to technical writing
+# Introduction to technical writing
 
 Socials: 
 - [LinkedIn](https://www.linkedin.com/in/wisdom-nwokocha-76212a77/) 
 - [Twitter](https://twitter.com/Joklinztech)
 
+Technical writing is writing about any technical issue, rather than a specialized technical topic such as computers. According to the Cambridge dictionary (The phrase "technical" refers to involving or needing special skills or knowledge ), which is the domain of experts and specialists. Whatever your major, you're honing your skills and becoming a specialist in a certain technical field. And you're engaging in technical communication whenever you try to write or speak about your field.
+## Key Characteristics of Technical Writing
+Like any other sort of writing, technical writing has certain qualities that set it apart from the rest. 
+If you want to write professionally, you need to understand the characteristics of technical writing. This form of writing aims to explain how to understand complex topics. How-to manuals and other items that provide direction are examples of technical writing. Therefore, if you want to have an excellent writing profession, you must first learn the features of technical writing.
+
+- Clear: Technical writing conveys information in a clear and concise manner, allowing minimal chance for misunderstanding. It necessitates the use of short, straightforward language.
+
+- Simple to comprehend: Effective technical writers avoid using terminology that people may not comprehend.
+
+- Very well-organized: This style of writing requires a clear structure that allows readers to follow along easily. Technical writing must be able to provide step-by-step directions to the readers.
+
+- Detailed: Technical writing is extremely thorough and insightful, leaving no room for interpretation. 
+
+- Focus on problem-solving: Technical documentation should be written with the goal of fixing problems in mind. These documents are used by readers to learn how to execute specific tasks or obtain technical knowledge, thus they should be simple to follow and organized in such a way that they can be easily referred to when issues arise.
+
+- Straightforward - This sort of writing is simple; it necessitates delivering information in a clear and to-the-point manner, without the use of literary tricks.
+
+## Goal of technical writing
+
+Every piece of writing has a goal. Some types of writing tell a tale, while others express the writer's ideas. Technical writing's primary goal is to convey complicated information to readers so that they can comprehend and use, even if they have no prior knowledge of the subject.
+
+- Technical writing describes how to use a certain object or complete a task or project.
+- It is aimed at readers looking for precise information, such as how to operate a computer or technical details on a new drug.
+- Technical writing must be clear, concise, and simple for the target audience to understand.
+- Technical writing should be technical.
+
+## Technical writing lifecycle
+
+![image](https://media-exp1.licdn.com/dms/image/C4D22AQHCbo2OF5h3zQ/feedshare-shrink_800/0/1651522269190?e=2147483647&v=beta&t=a_-mDkfBWNm60pJQBZfEHly7RuMgdGzRqJSw2sbk3eI) 
+
+The Documentation Development Life Cycle (DDLC) is a comprehensive documentation process. It's a well-organized list of the numerous procedures needed in producing any document. Therefore, a technical writer needs at the very least to have a conceptual understanding of DDLC to succeed in the field of documentation.
+
+This process is similar to the Software Development Life Cycle (SDLC). If you have studied software engineering, you can relate to that. This chapter will teach you about DDLC and its various phases required to document any content in technical writing.
+
+**Document Development Life Cycle**
+
+This involves the following steps:
+- Requirement Analysis 
+- Design Phase
+- Developing the content
+- Editing / Proofreading
+- Publishing
+- Maintenance
+
+### Requirement Analysis
+The first and most critical component of the DDLC is requirement analysis. Technical writers examine the project's requirements, tools utilized, and audience knowledge level during this phase. In addition, technical writers can learn about the type and requirements of a technical paper by analyzing the project.
+
+### Design Phase
+This phase covers content representation and gathering, such as how the content should be displayed, which document format should be used, how many pages need to be covered to meet the requirements, etc. SMEs (Subject Matter Experts) and the Internet should be used to gather as much knowledge about technology and audiences as possible. A good collection of data aids a technical writer in preparing an information-dense document.
+
+### Developing the content
+The actual content is scripted in this DDLC phase based on project design and planning. In addition, this phase involves the creation of graphics and illustrations.
+
+### Editing or ProofReading:
+In this phase, the document is checked thoroughly for consistency and spelling and grammatical errors.
+
+### Publish
+The technical writer publishes documents online. In most cases, technical documents are published in either hard copy or digital format. Depending on the client's needs, a variety of publication choices are available.
+
+### Maintain
+In this phase, a document backup is taken for future use. It also includes a collection of further updates and modifications to the document.
+
+## Writing Ethics
+
+According to Merriam-webster, Ethics is a system of accepted beliefs that control behavior, especially such a system based on morals (standards for good or bad character and behavior).
+
+In technical writing, ethics is a set of rules and standards for using resources when writing a technical document. Also, It means telling the truth and offering correct information, and it means telling the truth and delivering information so that a reasonable audience is aware of the behavior.
+
+As a professional writer, you should know the writing standards and obey them. I will list a few of the ethics in writing.
+- Use credible sources when adding content to your documents
+- Don't present false information
+- Show respect to others
+- Please don't use any ideas from others without mentioning or crediting them(Plagiarism). 
+- Don't ask for permission and document the source (Copyrighting).
+- Be correct and honest in your writing.
+- Don't manipulate data or statistics.
+
+The points above are a few ethics in writing that professional writers adhere to and teach others.

content/post/useofenglish.md

@@ -0,0 +1,189 @@
++++
+author = "Petra"
+title = "Use Of English"
+date = "2022-09-09"
+description = "Technical writing mentorship program second meetup"
++++
+
+Parts of speech
+- Sentence structure
+- Guidelines for structuring ideas in a sentence
+- Active and passive voice
+- Concord
+- Punctuation
+
+Technical writing is an aspect of English for Specific Purposes (ESP). In ESP,
+English is taught to suit the specific needs of diverse professions, occupations or
+activities. Now, technical writing is a form of writing that documents information
+about different specialties such as medical practice, computer and software
+engineering, technology, social science and so on. In technical writing, it is
+expected that appropriate register, vocabulary, voice, tense and rule of concord
+pertaining to the field under discourse be used. Areas to pay attention to in
+technical writing are discussed below.
+
+## PARTS OF SPEECH
+To do any kind of writing, words are needed and these words are taken from the seven
+parts of speech namely:
+
+1. Nouns
+2. Verbs
+3. Adjective
+4. Adverb
+5. Pronoun
+6. Preposition
+7. Conjunction
+
+## SENTENCE STRUCTURE
+- A sentence is a group of words that makes a complete thought which conveys a
+question, statement or a command, having a subject and a predicate.
+- Mastering the art of constructing refined sentences is essential to a good technical
+writing. It helps a writer communicate his thoughts effectively. A sentence structure
+is, therefore,
+
+A. How sentences are arranged grammatically to follow the subject-verb-object (SVO),
+subject-object-verb (SOV), verb-subject-object (VSO) and so on.
+
+A subject is a person or thing that performs an action. Example: Jacquard invented a
+programmable loom.
+
+An object is a person or thing that receives an action. Example: He destroyed the
+portable player.
+
+B. The four types of sentences - simple, compound, complex, compound-complex
+
+## SIMPLE SENTENCE
+- A simple sentence contains an independent clause and presents one single idea.
+- A clause is a group of words which contains a subject and a finite verb.
+- When a clause is independent, it makes a complete meaning and is a complete
+sentence on its own.
+- When a clause is dependent, it does not make complete meaning and needs to be
+attached to an independent clause to express a complete thought. A dependent clause is also called a subordinate clause.
+
+Examples of independent clause/simple sentences:
+- Computers store data.
+- The hard drive holds all of our data.
+- Our CPU is constantly taking instructions.
+
+## COMPOUND SENTENCE
+- A compound sentence has two independent clauses joined together using coordinating
+conjunctions such as and, nor, for, yet, so, therefore, but, or, nor.
+
+Examples:
+- The hard drive holds all of our data and our CPU is constantly taking instructions.
+- Computers communicate using machine language like binary but humans
+communicate using human languages like English.
+- We need to make a copy of our program in RAM so our CPU can process it.
+- A fitness tracker is a standalone device but it can also be a peripheral to your
+smartphone.
+
+## COMPLEX SENTENCES
+
+- A complex sentence contains one independent clause and one or more dependent or subordinate
+clauses.
+- When a clause is dependent, it does not make complete meaning and needs to be attached to an
+independent clause to express a complete thought.
+- A dependent clause is joined to an independent clause using subordinating conjunctions such as
+while, until, before, because, unless, if, although etc.
+Examples:
+- Some mobile devices are general purpose computing devices like tablets or smartphones while other
+mobile devices are optimized to perform a specific set of tasks like e-readers and smart watches.
+- Even though they are small, some mobile devices use peripherals such as bluetooth headphones.
+- Unless they are within their safe operating temperature range, don’t charge or discharge rechargeable
+batteries because batteries can swell, rupture and sometimes even catch fire.
+
+## GUIDELINES FOR A SUCCESSFUL TECHNICAL WRITING
+
+- Know your intended audience and plan ahead.
+- While a simple sentence can be effective for presenting your topic sentence in a
+paragraph, using a varied sentence structure is better than having strings of simple
+sentences. This is to avoid repetitive patterns.
+- Compound sentences join ideas that are related or have equal importance.
+- Do not overuse long sentences. This may cause your readers to lose track of main
+ideas.
+- Use clear words that are not ambiguous.
+- Be brief - only include relevant details.
+- Use more of active voice.
+
+## ACTIVE VOICE
+
+- Voice is the form of the verb that shows when a grammatical subject
+is the doer of an action or the receiver of an action. In the English
+language, we have the active and the passive voice.
+- ACTIVE VOICE: Here, the subject performs the action expressed by
+the verb. In technical writing, it is advisable to use more of active
+voice so it becomes clear who/what is carrying out an action or who
+invented what. Using the active voice emphasizes the agent of action.
+
+Examples:
+- Charles Babbage invented computer.
+- I designed the website.
+
+## PASSIVE VOICE
+- The subject receives the action depicted by the verb and it is
+formed by using the auxiliary verb ‘to be’ + past participle of
+the main verb.
+- Passive voice is used to avoid repetition or when the actor of an
+action is not known, or when the writer wants to hide the agent
+of an action.
+
+Examples:
+- Computers were invented (by Charles Babbage).
+- The website was designed (by me).
+
+## CONCORD
+- Concord means agreement.
+- In grammar, there are rules guiding the usage of certain words. As a writer,
+knowledge of these rules helps in communicating your ideas clearer.
+
+Some of the rules are:
+
+1) Subject and verb agreement
+- A singular subject goes with a singular verb
+Example: The motherboard holds our computer together.
+- Plural subjects go with plural verbs
+
+Example: 
+
+- The motherboard and RAM are components of the CPU.
+
+2) Proximity concord
+- In a list of nouns or pronouns, the choice of verb is determined by the noun or
+pronoun closest to it.
+
+Examples:
+- Either John or I am to be held responsible for the launching of the product.
+- The manager or the engineer is coming for the event.
+
+3) Accompaniment concord
+- When any of these words are used, alongside, together with, in collaboration with,
+including, with, as well as and so on, the verb is determined by the subject that comes
+before these accompaniment markers.
+
+Examples:
+- The mouse together with the keyboard is spoilt.
+- The men as well as the engineer are at the site.
+
+4) Notional concord
+- This refers to agreement of verbs with collective nouns based on meaning rather than
+grammatical form.
+- The context determines if the verb would be singular or plural.
+
+Example:
+- The committee decide who stays.
+- The committee meets every Thursday.
+- The police are here.
+- The police is your friend.
+
+## PUNCTUATION
+- End every sentence with a full stop, question mark or exclamation as is fit.
+- Capitalize the first letter of the first word in a sentence.
+- Capitalize people’s names: James, Rebecca
+- Days of the week: Monday, Sunday
+- Months of the year: July, June, March
+- Public holidays: Christmas, Easter, Sallah
+- Nationalities: Spanish, Nigerian
+- Languages: Igbo, German
+- Geographical locations: Mount Everest, The Mediterranean Sea
+- Company names: Apple, Microsoft
+- Religions: Christianity, Islam, Buddhism
+- First letter of the content words in titles of books: The Guardian Newspaper, Shakespeare

public/index.html

@@ -288,6 +288,26 @@ <h1 class="mt-1.5 mb-3 text-3xl font-bold">Technical Writing Resources</h1>
 
 
 
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Introduction To Technical Writer</h2>
+  <time class="text-sm opacity-60">Sep 10, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/intro/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Use Of English</h2>
+  <time class="text-sm opacity-60">Sep 9, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/useofenglish/"></a>
+</section>
+
+
+
+
+
 <section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
   <h2 class="!my-0 pb-1 !leading-none">Great Documentation</h2>
   <time class="text-sm opacity-60">Sep 2, 2022</time>

public/index.xml

@@ -7,7 +7,27 @@
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>
     <copyright>Copyright © 2022, Wisdom Nwokocha all rights reserved.</copyright>
-    <lastBuildDate>Fri, 02 Sep 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://technicalwriterresources.pages.dev/index.xml" rel="self" type="application/rss+xml" />
+    <lastBuildDate>Sat, 10 Sep 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://technicalwriterresources.pages.dev/index.xml" rel="self" type="application/rss+xml" />
+    <item>
+      <title>Introduction To Technical Writer</title>
+      <link>https://technicalwriterresources.pages.dev/post/intro/</link>
+      <pubDate>Sat, 10 Sep 2022 00:00:00 +0000</pubDate>
+
+      <guid>https://technicalwriterresources.pages.dev/post/intro/</guid>
+      <description>Introduction to technical writing Socials:
+LinkedIn Twitter Technical writing is writing about any technical issue, rather than a specialized technical topic such as computers. According to the Cambridge dictionary (The phrase &amp;ldquo;technical&amp;rdquo; refers to involving or needing special skills or knowledge ), which is the domain of experts and specialists. Whatever your major, you&amp;rsquo;re honing your skills and becoming a specialist in a certain technical field. And you&amp;rsquo;re engaging in technical communication whenever you try to write or speak about your field.</description>
+    </item>
+
+    <item>
+      <title>Use Of English</title>
+      <link>https://technicalwriterresources.pages.dev/post/useofenglish/</link>
+      <pubDate>Fri, 09 Sep 2022 00:00:00 +0000</pubDate>
+
+      <guid>https://technicalwriterresources.pages.dev/post/useofenglish/</guid>
+      <description>Parts of speech
+Sentence structure Guidelines for structuring ideas in a sentence Active and passive voice Concord Punctuation Technical writing is an aspect of English for Specific Purposes (ESP). In ESP, English is taught to suit the specific needs of diverse professions, occupations or activities. Now, technical writing is a form of writing that documents information about different specialties such as medical practice, computer and software engineering, technology, social science and so on.</description>
+    </item>
+
     <item>
       <title>Great Documentation</title>
       <link>https://technicalwriterresources.pages.dev/post/great-documentation/</link>

public/post/great-documentation/index.html

@@ -334,6 +334,15 @@ <h2 id="how-to-write-great-documentation">How to write great documentation?</h2>
 
 
 
+  <nav class="mt-24 flex rounded-lg bg-black/[3%] text-lg dark:bg-white/[8%]">
+
+    <a class="flex w-1/2 items-center p-6 pr-3 no-underline" href="https://technicalwriterresources.pages.dev/post/useofenglish/"
+      ><span class="mr-1.5">←</span><span>Use Of English</span></a
+    >
+
+
+  </nav>
+
 
 
 

public/post/index.html

@@ -262,6 +262,26 @@
 
 
 
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Introduction To Technical Writer</h2>
+  <time class="text-sm opacity-60">Sep 10, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/intro/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Use Of English</h2>
+  <time class="text-sm opacity-60">Sep 9, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/useofenglish/"></a>
+</section>
+
+
+
+
+
 <section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
   <h2 class="!my-0 pb-1 !leading-none">Great Documentation</h2>
   <time class="text-sm opacity-60">Sep 2, 2022</time>