de-intern-guide/assets/js/b51a1159.47aaf950.js

"use strict";(self.webpackChunkde_intern_tutorial=self.webpackChunkde_intern_tutorial||[]).push([[627],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>h});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=s(n),m=a,h=p["".concat(c,".").concat(m)]||p[m]||d[m]||i;return n?r.createElement(h,o(o({ref:t},u),{},{components:n})):r.createElement(h,o({ref:t},u))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[p]="string"==typeof e?e:a,o[1]=l;for(var s=2;s<i;s++)o[s]=n[s];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"},8779:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1},o="\ud83d\uddfa Technical Writing Overview",l={unversionedId:"technical-writing/technical-writing-overview",id:"technical-writing/technical-writing-overview",title:"\ud83d\uddfa Technical Writing Overview",description:"Though programming is a large part of software development, it's not the only part. In fact, it can become a small part. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through technical writing.",source:"@site/docs/technical-writing/technical-writing-overview.md",sourceDirName:"technical-writing",slug:"/technical-writing/technical-writing-overview",permalink:"/de-intern-guide/technical-writing/technical-writing-overview",draft:!1,editUrl:"https://github.com/dathere/de-intern-guide/tree/main/docs/technical-writing/technical-writing-overview.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"guideSidebar",previous:{title:"\u270d Technical Writing",permalink:"/de-intern-guide/category/-technical-writing"},next:{title:"\ud83d\udcdd Markdown",permalink:"/de-intern-guide/technical-writing/markdown"}},c={},s=[{value:"\ud83d\udcad Why Learn About Technical Writing?",id:"-why-learn-about-technical-writing",level:2},{value:"\u2705 Clear communication",id:"-clear-communication",level:3},{value:"\ud83d\udc54 Professional documentation",id:"-professional-documentation",level:3},{value:"\ud83d\udc4d User-friendly content",id:"-user-friendly-content",level:3},{value:"\ud83d\udee0 Maintainable projects",id:"-maintainable-projects",level:3},{value:"\ud83d\ude80 Improvement &amp; collaboration",id:"-improvement--collaboration",level:3},{value:"\ud83d\udcdd Where Can I Practice Technical Writing?",id:"-where-can-i-practice-technical-writing",level:2},{value:"\ud83d\udd0d Where Can I Learn More?",id:"-where-can-i-learn-more",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(p,(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"-technical-writing-overview"},"\ud83d\uddfa Technical Writing Overview"),(0,a.kt)("p",null,"Though programming is a large part of software development, it's not the only part. In fact, it can become a small part. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through ",(0,a.kt)("strong",{parentName:"p"},"technical writing"),"."),(0,a.kt)("h2",{id:"-why-learn-about-technical-writing"},"\ud83d\udcad Why Learn About Technical Writing?"),(0,a.kt)("p",null,"Technical writing offers several benefits that can enhance your professional communication skills and help others make sense of your work, be it a codebase, a project, or any other technical subject."),(0,a.kt)("p",null,"Here are some benefits of technical writing:"),(0,a.kt)("h3",{id:"-clear-communication"},"\u2705 Clear communication"),(0,a.kt)("p",null,"Technical writing isn't about using overly complex language that just ends up being difficult to understand. It's about taking complex information and conveying them in a clear and concise manner."),(0,a.kt)("h3",{id:"-professional-documentation"},"\ud83d\udc54 Professional documentation"),(0,a.kt)("p",null,"Technical writing can help you create professional documentation for your projects, which can help others understand your work and potentially contribute to it. Writing professional reports, proposals, presentations, and more in an organized manner can enhance your professional credibility and communication skills."),(0,a.kt)("h3",{id:"-user-friendly-content"},"\ud83d\udc4d User-friendly content"),(0,a.kt)("p",null,"Understanding your audience and what their needs, preferences, and level of expertise can help you create content that is easy to understand and accessible. This can be very helpful for creating user-friendly documentation, such as tutorials, guides, and manuals."),(0,a.kt)("h3",{id:"-maintainable-projects"},"\ud83d\udee0 Maintainable projects"),(0,a.kt)("p",null,"Just like building furniture without instructions can be like a nightmare, working and maintaining a project without documentation can be like a nightmare. Technical writing can help you share documentation that can help you and others maintain your projects and codebases."),(0,a.kt)("h3",{id:"-improvement--collaboration"},"\ud83d\ude80 Improvement & collaboration"),(0,a.kt)("p",null,"Sharing your work with others can help you get valuable feedback from your audience to improve your work, while also allowing others to learn from your work and potentially contribute to it."),(0,a.kt)("h2",{id:"-where-can-i-practice-technical-writing"},"\ud83d\udcdd Where Can I Practice Technical Writing?"),(0,a.kt)("p",null,"You can practice technical writing in many different scenarios, such as:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Code/API/Project Documentation"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"daily-standups"},"Daily standup notes")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"kanban-boards"},"Kanban boards")),(0,a.kt)("li",{parentName:"ul"},"Code comments"),(0,a.kt)("li",{parentName:"ul"},"GitHub issues"),(0,a.kt)("li",{parentName:"ul"},"GitHub pull requests"),(0,a.kt)("li",{parentName:"ul"},"Blog posts"),(0,a.kt)("li",{parentName:"ul"},"Case studies")),(0,a.kt)("h2",{id:"-where-can-i-learn-more"},"\ud83d\udd0d Where Can I Learn More?"),(0,a.kt)("p",null,"Practicing technical writing while getting feedback from others is a great way to learn where you can improve."),(0,a.kt)("p",null,"If you'd like to take courses on technical writing, here are a few technical writing courses from Google that you can take for free:"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Course"),(0,a.kt)("th",{parentName:"tr",align:null},"Summary"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/one"},"Technical Writing One")),(0,a.kt)("td",{parentName:"tr",align:null},"Learn the critical basics of technical writing. Take this course before taking any of the other courses.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/two"},"Technical Writing Two")),(0,a.kt)("td",{parentName:"tr",align:null},"Practice four intermediate topics in technical writing.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/error-messages"},"Writing Helpful Error Messages")),(0,a.kt)("td",{parentName:"tr",align:null},"Write clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.")))),(0,a.kt)("p",null,"I suggest adding course recommendations to your ",(0,a.kt)("a",{parentName:"p",href:"kanban-boards"},"kanban board")," and updating your progress as you go through them."),(0,a.kt)("p",null,"More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others."))}d.isMDXComponent=!0}}]);