this post was submitted on 19 Aug 2023
45 points (94.1% liked)

Programming

17482 readers
202 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]



founded 1 year ago
MODERATORS
 

cross-posted from: https://lemmy.ml/post/3560540

You probably have already noticed that nowadays it's becoming fashionable online to share technical material via videos (eg YouTube.)

I somehow can understand the appeal of creating videos for sharing thoughts/news, esp b/c it takes way less time and focus compared to writing things (just hit the record button and go.)

But videos are. ๐Ÿ‘Ž not index-able (at least locally)
๐Ÿ‘Ž not searchable. ๐Ÿ‘Ž not copy-paste friendly if at all. ๐Ÿ‘Ž impossible to skim through.
๐Ÿ‘Ž a major distraction from the train of thoughts.

IMO, in most cases, the more effective and impactful medium of technical comms is the written form: a Mastodon toot, a blog post, a gist, a Pastebin entry or even a Facebook post!

What are your thoughts?

you are viewing a single comment's thread
view the rest of the comments
[โ€“] [email protected] 6 points 1 year ago

Videos are not documentation.

They can be used to demonstrate examples of how to do a particular task, but as other commenters have mentioned, documentation involves listing classes, functions, parameters, etc and clearly explaining what they all do, in a searchable manner. Text is searchable, video is not.