We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Write Docs Devs Love: Ten Tricks To Level Up Your Tech Writing

00:00

Formale Metadaten

Titel
Write Docs Devs Love: Ten Tricks To Level Up Your Tech Writing
Serientitel
Anzahl der Teile
112
Autor
Lizenz
CC-Namensnennung - keine kommerzielle Nutzung - Weitergabe unter gleichen Bedingungen 4.0 International:
Sie dürfen das Werk bzw. den Inhalt zu jedem legalen und nicht-kommerziellen Zweck nutzen, verändern und in unveränderter oder veränderter Form vervielfältigen, verbreiten und öffentlich zugänglich machen, sofern Sie den Namen des Autors/Rechteinhabers in der von ihm festgelegten Weise nennen und das Werk bzw. diesen Inhalt auch in veränderter Form nur unter den Bedingungen dieser Lizenz weitergeben.
Identifikatoren
Herausgeber
Erscheinungsjahr
Sprache

Inhaltliche Metadaten

Fachgebiet
Genre
Abstract
Think of that feeling you get when you follow an online tutorial or documentation and the code works on the first run. Now think of all the hours spent wasted following broken, outdated, or incomplete documentation. From our favorite tutorials to bad product docs we all consume technical writing. Tutorials, blog posts, and product docs help developers learn new things, build projects, and debug issues. But what makes one tutorial better than another? In this talk I'll discuss how you can write the documentation that developers love and I’ll share 10 tips and tricks to improve your technical writing. Outline * Introduction (1 min) * Why is Technical Writing Important? (4 min) * My Top 10 Tips to improve your Technical Writing (20 min) * # 10 - Make Your End Goal Clear * # 9 - Don’t Be Overly Verbose * # 8 - Inclusive Language * Avoid words like Simple, Easy * # 7 - Avoid Technical Jargon * # 6 - Define ALL Acronyms * # 5 - Avoid Memes/Colloquialisms * # 4 - Use Meaningful Code Samples and Variable Names * # 3 - Don’t Make Your Reader Leave Your Article * # 2 - Make it Easy for the Reader to Find a Single Piece of Information * # 1 - Verify Your Instructions! Test, Test, Test! * # 0 Bonus! - Practice, Practice, Practice * How You Can Get Started in Technical Writing (3 min) * Conclusion & Questions (2 min)
Schreiben <Datenverarbeitung>MaschinencodeQuellcodeProgrammbibliothekMaschinencodeProjektive EbeneProgrammbibliothekWort <Informatik>TouchscreenSchreiben <Datenverarbeitung>InformationNatürliche SpracheRechenschieberBitElektronische BibliothekMultiplikationsoperatorSatellitensystemWeb SiteZweiHomepageMinimumDifferenteKartesische KoordinatenRandomisierungSoftwareentwicklerCoxeter-GruppeZahlenbereichOpen SourceSchlussregelQuellcodeVerschlingungTaskRichtungWeb-DesignerQuadratzahlVirtuelle MaschineBenutzerbeteiligungServerQR-CodeMailing-ListeYouTubeNeuroinformatikHardwareMinkowski-MetrikFigurierte ZahlSchlüsselverwaltungPunktComputeranimation
Overlay-NetzSatellitensystemGradientSchreiben <Datenverarbeitung>MAPKrümmungsmaßInternetworkingSoftwareentwicklerSkriptspracheAppletInstallation <Informatik>QuellcodeInverser LimesRegulärer Ausdruck <Textverarbeitung>Inhalt <Mathematik>Physikalisches SystemDirekte numerische SimulationDNS <Internet>Divergente ReiheVerschlingungVorzeichen <Mathematik>SystemzusammenbruchProgrammbibliothekStichprobeMaschinencodeZahlenbereichZweiPufferüberlaufWort <Informatik>SystemplattformMaschinencodeReelle ZahlDeskriptive StatistikGeschlecht <Mathematik>Keller <Informatik>Schreib-Lese-KopfDivergente ReiheGüte der AnpassungNatürliche SpracheARM <Computerarchitektur>DifferenteProgrammbibliothekGruppenoperationDirekte numerische SimulationArithmetisches MittelVerschlingungMultiplikationsoperatorStichprobenumfangDialektVariableLesen <Datenverarbeitung>SchätzfunktionBitMAPProjektive EbeneMultiplikationInverser LimesSoftwareInhalt <Mathematik>DatensatzSchreiben <Datenverarbeitung>BenutzerbeteiligungQuellcodeServerDomain-NameSoftwareentwicklerPhysikalisches SystemGradientInklusion <Mathematik>MereologieInstallation <Informatik>InternetworkingGebundener ZustandExpertensystemBefehl <Informatik>Computeranimation
MaschinencodeStichprobeGanze Funktionp-BlockSchreiben <Datenverarbeitung>Befehl <Informatik>TaskVerschlingungGerichtete MengeSchnittmengeInstallation <Informatik>KontrollstrukturUmwandlungsenthalpieProgrammierumgebungInformationInhalt <Mathematik>TabelleProgrammbibliothekTexteditorVerschlingungEinfache GenauigkeitWort <Informatik>MereologieElektronischer ProgrammführerTaskFrequenzVariableBefehl <Informatik>p-BlockAppletApp <Programm>MusterspracheMultiplikationsoperatorGüte der AnpassungMathematikInhalt <Mathematik>WiderspruchsfreiheitElektronische PublikationElektronische BibliothekTabelleProgrammbibliothekZahlenbereichVirtuelle RealitätSchreib-Lese-KopfQuick-SortInstallation <Informatik>VersionsverwaltungRechter WinkelMaschinencodeFunktionalMinimumProgrammierumgebungKeller <Informatik>Web SiteMailing-ListeGamecontrollerServerInformationGoogolVorlesung/KonferenzComputeranimation
Inhalt <Mathematik>InformationTabelleProgrammbibliothekWiderspruchsfreiheitSchreiben <Datenverarbeitung>ProgrammverifikationSoftwaretestPeer-to-Peer-NetzTexteditorProgrammierumgebungSchnelltasteWorkstation <Musikinstrument>Web logOpen SourceTwitter <Softwareplattform>RechenschieberElektronischer ProgrammführerMultiplikationsoperatorKonfiguration <Informatik>SpieltheorieZahlenbereichFigurierte ZahlProjektive EbeneProgrammierumgebungTwitter <Softwareplattform>Web logRechenschieberSchnelltasteWorkstation <Musikinstrument>Physikalisches SystemOpen SourceSoftwaretestHilfesystemProgrammfehlerQuellcodeSystemplattformRechter WinkelSchreiben <Datenverarbeitung>TypentheorieDifferenteMaschinencodeSchnittmengeMereologieComputeranimation
Twitter <Softwareplattform>RechenschieberComputeranimation
Transkript: Englisch(automatisch erzeugt)