sudoevans · August 27, 2024 11:42 · Aug 27, 2024
diff --git a/Technical-writing.md b/Technical-writing.md
@@ -0,0 +1,47 @@
+Technical Writing.
+Know Your Audience.
+
+
+Who are you talking to? Are they tech experts or regular folks?
+
+What do they already know? Don't overwhelm them with jargon.
+
+What do they need to know? Focus on the essential information.
+
+
+
+## Be Clear and Simple
+
+
+Use plain language: Avoid fancy words. Think "start" instead of "initiate."
+
+Break it down: Complex ideas? Split them into smaller, easier-to-digest chunks.
+
+Show, don't tell: Use examples and visuals to explain things.
+
+Be consistent: Stick to the same terms and style throughout.
+
+
+
+## Structure is Key
+
+
+Headings and subheadings: Guide your reader through the content.
+
+Bullet points and numbered lists: Make information easy to scan.
+
+Visuals: Use images, diagrams, or charts to clarify complex points.
+
+
+## The Art of the Readme
+
+
+A Readme is like a welcome guide for your product.
+
+Be upfront: Tell people what the product does right away.
+
+Keep it simple: Assume no prior knowledge.
+
+Include clear steps: Guide users through setup and basic use.
+
+Anticipate problems: Offer solutions to common issues.