mirror of
https://github.com/dathere/de-intern-guide.git
synced 2025-12-19 08:39:25 +00:00
16 lines
No EOL
22 KiB
HTML
16 lines
No EOL
22 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-technical-writing/technical-writing-overview">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.1">
|
||
<title data-rh="true">🗺 Technical Writing Overview | Intern Onboarding Guide</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://dathere.github.io/de-intern-guide/img/datHere-logo.png"><meta data-rh="true" name="twitter:image" content="https://dathere.github.io/de-intern-guide/img/datHere-logo.png"><meta data-rh="true" property="og:url" content="https://dathere.github.io/de-intern-guide/technical-writing/technical-writing-overview"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="🗺 Technical Writing Overview | Intern Onboarding Guide"><meta data-rh="true" name="description" content="Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. 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."><meta data-rh="true" property="og:description" content="Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. 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."><link data-rh="true" rel="icon" href="/de-intern-guide/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://dathere.github.io/de-intern-guide/technical-writing/technical-writing-overview"><link data-rh="true" rel="alternate" href="https://dathere.github.io/de-intern-guide/technical-writing/technical-writing-overview" hreflang="en"><link data-rh="true" rel="alternate" href="https://dathere.github.io/de-intern-guide/technical-writing/technical-writing-overview" hreflang="x-default"><link rel="stylesheet" href="/de-intern-guide/assets/css/styles.f419e4b1.css">
|
||
<link rel="preload" href="/de-intern-guide/assets/js/runtime~main.788e849b.js" as="script">
|
||
<link rel="preload" href="/de-intern-guide/assets/js/main.c2601a50.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/de-intern-guide/"><div class="navbar__logo"><img src="/de-intern-guide/img/datHere-logo.png" alt="datHere Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/de-intern-guide/img/datHere-logo-dark.png" alt="datHere Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Intern Onboarding Guide</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/de-intern-guide/">📖 Guide</a><a class="navbar__item navbar__link" href="/de-intern-guide/about">💡 About</a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/de-intern-guide/">👋 Welcome to datHere!</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/de-intern-guide/category/-onboarding-setup">✈ Onboarding Setup</a><button aria-label="Toggle the collapsible sidebar category '✈ Onboarding Setup'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/de-intern-guide/category/-qsv">⚡ qsv</a><button aria-label="Toggle the collapsible sidebar category '⚡ qsv'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/de-intern-guide/category/-technical-writing">✍ Technical Writing</a><button aria-label="Toggle the collapsible sidebar category '✍ Technical Writing'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/de-intern-guide/technical-writing/technical-writing-overview">🗺 Technical Writing Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/de-intern-guide/technical-writing/markdown">📝 Markdown</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/de-intern-guide/technical-writing/daily-standups">☕ Daily Standups</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/de-intern-guide/technical-writing/kanban-boards">🛹 Kanban Boards</a></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/de-intern-guide/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/de-intern-guide/category/-technical-writing"><span itemprop="name">✍ Technical Writing</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">🗺 Technical Writing Overview</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>🗺 Technical Writing Overview</h1><p>Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. 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 <strong>technical writing</strong>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="-why-learn-about-technical-writing">💭 Why Learn About Technical Writing?<a href="#-why-learn-about-technical-writing" class="hash-link" aria-label="Direct link to 💭 Why Learn About Technical Writing?" title="Direct link to 💭 Why Learn About Technical Writing?"></a></h2><p>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.</p><p>Here are some benefits of technical writing:</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="-clear-communication">✅ Clear communication<a href="#-clear-communication" class="hash-link" aria-label="Direct link to ✅ Clear communication" title="Direct link to ✅ Clear communication"></a></h3><p>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.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="-professional-documentation">👔 Professional documentation<a href="#-professional-documentation" class="hash-link" aria-label="Direct link to 👔 Professional documentation" title="Direct link to 👔 Professional documentation"></a></h3><p>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.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="-user-friendly-content">👍 User-friendly content<a href="#-user-friendly-content" class="hash-link" aria-label="Direct link to 👍 User-friendly content" title="Direct link to 👍 User-friendly content"></a></h3><p>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.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="-maintainable-projects">🛠 Maintainable projects<a href="#-maintainable-projects" class="hash-link" aria-label="Direct link to 🛠 Maintainable projects" title="Direct link to 🛠 Maintainable projects"></a></h3><p>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.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="-improvement--collaboration">🚀 Improvement & collaboration<a href="#-improvement--collaboration" class="hash-link" aria-label="Direct link to 🚀 Improvement & collaboration" title="Direct link to 🚀 Improvement & collaboration"></a></h3><p>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.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="-where-can-i-practice-technical-writing">📝 Where Can I Practice Technical Writing?<a href="#-where-can-i-practice-technical-writing" class="hash-link" aria-label="Direct link to 📝 Where Can I Practice Technical Writing?" title="Direct link to 📝 Where Can I Practice Technical Writing?"></a></h2><p>You can practice technical writing in many different scenarios, such as:</p><ul><li>Code/API/Project Documentation</li><li><a href="/de-intern-guide/technical-writing/daily-standups">Daily standup notes</a></li><li><a href="/de-intern-guide/technical-writing/kanban-boards">Kanban boards</a></li><li>Code comments</li><li>GitHub issues</li><li>GitHub pull requests</li><li>Blog posts</li><li>Case studies</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="-where-can-i-learn-more">🔍 Where Can I Learn More?<a href="#-where-can-i-learn-more" class="hash-link" aria-label="Direct link to 🔍 Where Can I Learn More?" title="Direct link to 🔍 Where Can I Learn More?"></a></h2><p>Practicing technical writing while getting feedback from others is a great way to learn where you can improve.</p><p>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:</p><table><thead><tr><th>Course</th><th>Summary</th></tr></thead><tbody><tr><td><a href="https://developers.google.com/tech-writing/one" target="_blank" rel="noopener noreferrer">Technical Writing One</a></td><td>Learn the critical basics of technical writing. Take this course before taking any of the other courses.</td></tr><tr><td><a href="https://developers.google.com/tech-writing/two" target="_blank" rel="noopener noreferrer">Technical Writing Two</a></td><td>Practice four intermediate topics in technical writing.</td></tr><tr><td><a href="https://developers.google.com/tech-writing/error-messages" target="_blank" rel="noopener noreferrer">Writing Helpful Error Messages</a></td><td>Write clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.</td></tr></tbody></table><p>I suggest adding course recommendations to your <a href="/de-intern-guide/technical-writing/kanban-boards">kanban board</a> and updating your progress as you go through them.</p><p>More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/dathere/de-intern-guide/tree/main/docs/technical-writing/technical-writing-overview.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/de-intern-guide/category/-technical-writing"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">✍ Technical Writing</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/de-intern-guide/technical-writing/markdown"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">📝 Markdown</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#-why-learn-about-technical-writing" class="table-of-contents__link toc-highlight">💭 Why Learn About Technical Writing?</a><ul><li><a href="#-clear-communication" class="table-of-contents__link toc-highlight">✅ Clear communication</a></li><li><a href="#-professional-documentation" class="table-of-contents__link toc-highlight">👔 Professional documentation</a></li><li><a href="#-user-friendly-content" class="table-of-contents__link toc-highlight">👍 User-friendly content</a></li><li><a href="#-maintainable-projects" class="table-of-contents__link toc-highlight">🛠 Maintainable projects</a></li><li><a href="#-improvement--collaboration" class="table-of-contents__link toc-highlight">🚀 Improvement & collaboration</a></li></ul></li><li><a href="#-where-can-i-practice-technical-writing" class="table-of-contents__link toc-highlight">📝 Where Can I Practice Technical Writing?</a></li><li><a href="#-where-can-i-learn-more" class="table-of-contents__link toc-highlight">🔍 Where Can I Learn More?</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">datHere Socials</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://dathere.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/dathere" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.linkedin.com/company/dathere/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://dathere.com/blog/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 datHere, Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||
<script src="/de-intern-guide/assets/js/runtime~main.788e849b.js"></script>
|
||
<script src="/de-intern-guide/assets/js/main.c2601a50.js"></script>
|
||
</body>
|
||
</html> |