Writing technical documentation

  Рет қаралды 133,586

Fredrik Christenson

Fredrik Christenson

Күн бұрын

Пікірлер: 40
@davem.8681
@davem.8681 5 жыл бұрын
Documentation is a subject that is highly underrated , for sure.
@H12-q7x
@H12-q7x 4 жыл бұрын
@@depression_isnt_real if you can't your doing it wrong
@techne_
@techne_ Жыл бұрын
He is not. No docs === no product.
@ahmer9800
@ahmer9800 5 жыл бұрын
Thank you Fredrik. Your videos are really helping me become better at understanding the needs of software development.
@FredrikChristenson
@FredrikChristenson 5 жыл бұрын
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 жыл бұрын
Wish I would've noticed this video before my last interview coding challenge.
@AshutoshChaudhary2k14
@AshutoshChaudhary2k14 5 жыл бұрын
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 жыл бұрын
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 жыл бұрын
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 жыл бұрын
@@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 жыл бұрын
Agreed, I am really wanting to learn *how* to write effective documentation, rather than a video that feels like it is sponsored by bookstack…
@rosyfajardo5816
@rosyfajardo5816 5 жыл бұрын
Thank you so much for sharing.
@nlburnr1
@nlburnr1 6 жыл бұрын
Man really enjoy your content you really add some thing new in this youtube development community thnx
@FredrikChristenson
@FredrikChristenson 6 жыл бұрын
Hi m8! Thank you I feel very flattered that you feel that way and thank you so much for watching!
@versacebroccoli7238
@versacebroccoli7238 Жыл бұрын
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.
@flaviuse
@flaviuse 5 жыл бұрын
We use Outline now, self hosted and very simple
@the_yb7
@the_yb7 2 жыл бұрын
is it free?
@Doakio
@Doakio 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!
@kingofyoutube1746
@kingofyoutube1746 3 жыл бұрын
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 3 жыл бұрын
Depends on who the docs are for.
@kingofyoutube1746
@kingofyoutube1746 3 жыл бұрын
@@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 3 жыл бұрын
@@FredrikChristenson can you help me pls
@robertjennings397
@robertjennings397 4 жыл бұрын
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.
@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
@fredericklane745
@fredericklane745 3 жыл бұрын
How does this compare in functionality to Google Sites?
@abdulrehmanqureshi5914
@abdulrehmanqureshi5914 5 жыл бұрын
need to write technical proposals, developer guide, please guide me with tools
@ronin0829
@ronin0829 3 жыл бұрын
👌👌👌
@paulstaley4245
@paulstaley4245 4 жыл бұрын
Your MacBook battery was low and you didn't have it plugged in. that bothered me.
@mayank_upadhyay_19
@mayank_upadhyay_19 4 жыл бұрын
Everyone have a basic idea of their device's battery performance, so don't worry :)
@CayoBuay
@CayoBuay 2 жыл бұрын
Misleading video, should be called Using bookstack with company terms in mind.
@haraldlons
@haraldlons 5 жыл бұрын
Really good video
@IMateme
@IMateme 5 жыл бұрын
thank you very much! but please how to setup the Application ???
@kene6753
@kene6753 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.
@markcuello5
@markcuello5 2 жыл бұрын
SECURITY
@vtreanor
@vtreanor 3 жыл бұрын
Too much idle chatter, I gave up!
Writing great documentation
30:38
Igor Starikov
Рет қаралды 38 М.
How to Document Your Code Like a Pro
19:03
ArjanCodes
Рет қаралды 103 М.
So Cute 🥰 who is better?
00:15
dednahype
Рет қаралды 19 МЛН
REAL or FAKE? #beatbox #tiktok
01:03
BeatboxJCOP
Рет қаралды 17 МЛН
How Many Balloons To Make A Store Fly?
00:22
MrBeast
Рет қаралды 199 МЛН
Software Planning and Technical Documentation
10:49
AltexSoft
Рет қаралды 164 М.
How To Write Design Docs
17:23
Timothy Cain
Рет қаралды 66 М.
How Senior Programmers ACTUALLY Write Code
13:37
Thriving Technologist
Рет қаралды 1,6 МЛН
What is a Technical Report Document?
11:46
Technical Writer HQ
Рет қаралды 22 М.
Use Obsidian (BEST Markdown editor) for note taking and tech docs!
17:56
Christian Lempa
Рет қаралды 390 М.
Don't Write Comments
5:55
CodeAesthetic
Рет қаралды 828 М.
Software Documentation Examples to Inspire You
16:39
Technical Writer HQ
Рет қаралды 43 М.
Why Developers Are OBSESSED With Obsidian
11:26
Amichai Mantinband
Рет қаралды 64 М.
So Cute 🥰 who is better?
00:15
dednahype
Рет қаралды 19 МЛН