Software Documentation Examples to Inspire You

Sdílet
Vložit
  • čas přidán 20. 08. 2024
  • If you're interested in learning more about documentation, then download the syllabus for the technical writing courses on Technical Writer HQ: technicalwrite...
    ---
    Detailed documentation is an essential component of the package that makes up a software solution. Software documentation helps customers make the best use of software products; developers, programmers, and project managers successfully execute software development projects, and businesses sell and support software. The two main types of documentation that pertain to the software itself are user documentation and developer documentation.
    ---
    Before we dive into the topic, subscribe to our CZcams channel here to keep up with everything technical writing: bit.ly/3snITet
    Want to connect with other technical writers? Join our exclusive community of technical writers here: bit.ly/twhq-co...
    Connect with me here:
    LinkedIn: / joshua-fechter
    Twitter: / joshfechter5
    Instagram: / joshua.fechter
    #softwaredocumentation #softwaredocumentationexamples #JoshFechter

Komentáře • 14

  • @Adventure_Food_Fun_US

    What a great video! Thank you so much

  • @ALCRAN2010
    @ALCRAN2010 Před rokem +6

    Really cool, wonderful presentation! Curious to see a video on perhaps - parallel job paths that Tech Writers can jump in and out of. For example Project Manager, or Business Process Analyst.

  • @govardhanreddy4828
    @govardhanreddy4828 Před rokem

    Its simple and formal explanation on overall documentation process. It's helped me more to prepare my task.

  • @krishnareddy1534
    @krishnareddy1534 Před 5 měsíci

    Theory is perfect ...need practical knowledge too ..how to do the process starting to end

  • @_chris_6786
    @_chris_6786 Před rokem

    Simply outstanding. Thanks a lot!

  • @gouravterwadkar4731
    @gouravterwadkar4731 Před rokem +2

    great explanation

  • @uvahh
    @uvahh Před rokem

    Thank you so much! This video has helped me dive into our documentation. What are your feelings on ChatGPT, and what does the future of technical documentation and guides face?

    • @Kingside88
      @Kingside88 Před 16 dny

      Writer uses ChatGPT for writing documentation (from legacy bs code) and Reader for reading and summing up the documentation.

  • @MD-ln9pm
    @MD-ln9pm Před 4 dny

    Hi I would like to know if there is a IT Documentation software online that I could put all my guide,process,network diagram. I know there is Hudu or ItGlue. Is there a alternative

  • @soaham3574
    @soaham3574 Před 6 měsíci

    Too good!

  • @sabrinamaria8898
    @sabrinamaria8898 Před rokem

    perfect perfect perfect!!! thx

  • @cbenton13
    @cbenton13 Před 7 měsíci

    I landed a Job as a Technical Writer for a Gov. software developer, but have never performed in a technical writer role. Would your Basic Technical Writer course be my best option to get spun up, or is there a different, more specific course I should invest in?

    • @justincv
      @justincv Před 7 měsíci +1

      Invest in gpt AI. That's it

    • @ashez002
      @ashez002 Před 2 měsíci

      @@justincv do you want to say that it will do most of the Tech Writer`s job in the near future?