Writing technical documentation

แชร์
ฝัง
  • เผยแพร่เมื่อ 7 ก.ย. 2024

ความคิดเห็น • 40

  • @davem.8681
    @davem.8681 5 ปีที่แล้ว +67

    Documentation is a subject that is highly underrated , for sure.

    • @user-zo6nn2ih2f
      @user-zo6nn2ih2f 4 ปีที่แล้ว +1

      @@depression_isnt_real if you can't your doing it wrong

    • @techne_
      @techne_ ปีที่แล้ว +1

      He is not. No docs === no product.

  • @ahmer9800
    @ahmer9800 5 ปีที่แล้ว +10

    Thank you Fredrik. Your videos are really helping me become better at understanding the needs of software development.

    • @FredrikChristenson
      @FredrikChristenson  5 ปีที่แล้ว +2

      Glad to hear it m8!
      If you have any question or requests let me know.
      Have a great day and thank you so much for watching!

  • @MrPDTaylor
    @MrPDTaylor 4 ปีที่แล้ว +9

    Wish I would've noticed this video before my last interview coding challenge.

  • @nlburnr1
    @nlburnr1 6 ปีที่แล้ว +6

    Man really enjoy your content you really add some thing new in this youtube development community thnx

    • @FredrikChristenson
      @FredrikChristenson  6 ปีที่แล้ว +1

      Hi m8!
      Thank you I feel very flattered that you feel that way and thank you so much for watching!

  • @AshutoshChaudhary2k14
    @AshutoshChaudhary2k14 4 ปีที่แล้ว +38

    I was expecting a video explaining UML diagrams, mocks, technical specification documentation, However, it ended being a tutorial to bookstack and some very managerial things. I am sorry but this is a misleading video title

    • @shujahanif89
      @shujahanif89 4 ปีที่แล้ว +3

      If you found a good link for a video which explains technical specification documentation and other stuff mentioned by you, please share the link!

    • @novaria
      @novaria 4 ปีที่แล้ว +5

      You two might be interested in www.writethedocs.org
      It's a global community of documentarians (people that care about well written documentation) and a great resource in general.

    • @britanyvanblake8070
      @britanyvanblake8070 4 ปีที่แล้ว +3

      @@novaria Yes! I attended my first WtD this year and it was great, I'm seriously considering registering for the Prague and Aus/India conferences as well even if it means pulling all-nighters to attend :D

    • @Cmppayne26542
      @Cmppayne26542 2 ปีที่แล้ว +2

      Agreed, I am really wanting to learn *how* to write effective documentation, rather than a video that feels like it is sponsored by bookstack…

  • @Doakio
    @Doakio 4 ปีที่แล้ว +4

    Great video. Search-ability is indeed king in documentation. To that end, we recommend never putting text annotation inside screen grabs. Rather, put numbers pointing to elements within the screenshot, and keep your annotation outside of the image, in plain text. Also, make sure you use Title Case When Writing Article Titles, Chapter, Titles, and the like. There were several instances in the video that showed a title without proper capitalization. Keep on making great content!

  • @rosyfajardo5816
    @rosyfajardo5816 5 ปีที่แล้ว +3

    Thank you so much for sharing.

  • @versacebroccoli7238
    @versacebroccoli7238 10 หลายเดือนก่อน

    I almost always write a really bad first draft. I noticed I editorialize a lot and often more than half of the words I typed are useless. But rewriting helps.

  • @ronin0829
    @ronin0829 3 ปีที่แล้ว

    👌👌👌

  • @flaviuse
    @flaviuse 5 ปีที่แล้ว +3

    We use Outline now, self hosted and very simple

    • @the_yb7
      @the_yb7 2 ปีที่แล้ว

      is it free?

  • @granand
    @granand 3 ปีที่แล้ว

    Thank you, it is useful to me I am here first time, to have continuity please can you share the first video the dockers or the video which is pre-requisite video

  • @robertjennings397
    @robertjennings397 3 ปีที่แล้ว

    My shrink suggested documentation, writer, 35 years ago.

  • @thelovertunisia
    @thelovertunisia 4 ปีที่แล้ว

    Well I got to your channel through this same question. Why android apps do not have a documentation i.e. help menu like desktop apps which themselves often no longer have offline help.

  • @paulstaley4245
    @paulstaley4245 4 ปีที่แล้ว +6

    Your MacBook battery was low and you didn't have it plugged in. that bothered me.

    • @mayank_upadhyay_19
      @mayank_upadhyay_19 3 ปีที่แล้ว +1

      Everyone have a basic idea of their device's battery performance, so don't worry :)

  • @haraldlons
    @haraldlons 5 ปีที่แล้ว

    Really good video

  • @abdulrehmanqureshi5914
    @abdulrehmanqureshi5914 4 ปีที่แล้ว +1

    need to write technical proposals, developer guide, please guide me with tools

  • @CayoBuay
    @CayoBuay ปีที่แล้ว +1

    Misleading video, should be called Using bookstack with company terms in mind.

  • @fredericklane745
    @fredericklane745 3 ปีที่แล้ว

    How does this compare in functionality to Google Sites?

  • @kingofyoutube1746
    @kingofyoutube1746 2 ปีที่แล้ว

    Hi I'm asked to prepare process documentation about a feature of a social media platform. Can you please recommend what to choose and how to start doing it?

    • @FredrikChristenson
      @FredrikChristenson  2 ปีที่แล้ว

      Depends on who the docs are for.

    • @kingofyoutube1746
      @kingofyoutube1746 2 ปีที่แล้ว

      @@FredrikChristenson you mean if it's for users or for company? It's asked for business analyst interview. So i think it's for the company

    • @kingofyoutube1746
      @kingofyoutube1746 2 ปีที่แล้ว

      @@FredrikChristenson can you help me pls

  • @kene6753
    @kene6753 2 ปีที่แล้ว +2

    There's barely a mention of how to write a good technical specification. Please stick to the topic or the title of the vid otherwise, people might feel misled.

  • @gzoechi
    @gzoechi ปีที่แล้ว

    Storing documentation in a database sounds like a poor approach. It should be stored in Git.

  • @vtreanor
    @vtreanor 3 ปีที่แล้ว +2

    Too much idle chatter, I gave up!

  • @markcuello5
    @markcuello5 ปีที่แล้ว

    SECURITY

  • @IMateme
    @IMateme 4 ปีที่แล้ว

    thank you very much! but please how to setup the Application ???