Тёмный

Software tools for creating awesome engineering documentation 

Sayanee Basu
Подписаться 12 тыс.
Просмотров 32 тыс.
50% 1

Опубликовано:

 

28 сен 2024

Поделиться:

Ссылка:

Скачать:

Готовим ссылку...

Добавить в:

Мой плейлист
Посмотреть позже
Комментарии : 51   
@_-martin-_
@_-martin-_ 4 года назад
FYI - Markdown is simply a specific implementation of the category of languages we call Markup. For sure markup languages are the future way of documenting especially technical engineering projects, small and large.
@gold-junge91
@gold-junge91 3 года назад
Thanks for this video. I’m mechanical Engineer and this give me a lot of ideas 💡 how i can make nice documentations
@nathanstrik
@nathanstrik 2 года назад
It feels like you unloaded your brain into a video. Very interesting and amazingly useful tips, thank you for sharing your knowledge.
@AnirudhMathur17
@AnirudhMathur17 3 года назад
Absolutely wonderful !! Thank you so much Sayanee for this extremely useful & informative walkthrough of markdown.
@151manasa
@151manasa Год назад
thanks you for the info. I have been slopy with my documentations over the years. I will get back on track with your advice.
@ashishthapliyal6992
@ashishthapliyal6992 2 года назад
Thanks a ton for sharing these tools. It’s been a struggle to draw flow charts with drag and drop tools.
@ranjithmkumar
@ranjithmkumar 3 года назад
This is a great video. Also it is not surprising that Hardware folks are never aware of JS frameworks. I have worked both on web application and embedded application. Never thought of making use of these js libraries for use. Thanks!!
@sayanee
@sayanee 3 года назад
Yes, you have identified the skill or awareness gap between the hardware and web developers correctly :) As I learn how to use these skills from both areas in IoT technologies, I hope to share them in such videos as well.
@ranjithmkumar
@ranjithmkumar 3 года назад
@@sayanee Looking forward. I am also watching the videos that I have missed from the channel.
@dipalzambare9257
@dipalzambare9257 2 года назад
Great info,thanks, Many organisations still use microsoft word as primary documentation software, (ultimately it is duplicated in fancy Adobe suite but mostly it starts with ms word) which is probably worst choice. Text based document is way to go forward.
@camcairns2584
@camcairns2584 Год назад
Nicely presented. Lucid and to the point. Thanks for sharing.
@NoelTanner
@NoelTanner 3 года назад
This is awesome, I'm now subscribed!
@Gourab__paul
@Gourab__paul 2 года назад
This is very helpful. Thank you for the details.
@peepokekler
@peepokekler 2 года назад
Great info. Thank you!
@adomovic323
@adomovic323 3 года назад
Wow, very helpful.... Great video thank you :)
@krishnapic6164
@krishnapic6164 4 года назад
Thanks Madam. From south India.
@Beebeelol55
@Beebeelol55 3 года назад
Great methodology 👍💖
@RajeshKamisetty
@RajeshKamisetty Год назад
👍🏼 learnt a lot in such a short time… #writethedocs
@DarianCabot
@DarianCabot 4 года назад
Great video, thanks 👍
@1566chandra
@1566chandra 2 года назад
Thank you so much
@Cutycats9
@Cutycats9 4 года назад
Good work 👍❤
@parthkumarbera1090
@parthkumarbera1090 4 года назад
Thank you
@trumpetpunk42
@trumpetpunk42 3 года назад
This is one of the best tech videos I've seen. Good balance of telling me about a couple things I hadn't seen before, and showing how to use. The completeness of your references and toc in the description was so useful.
@ubidefeo
@ubidefeo 4 года назад
Thank you for another great video, Sayanee. I didn't know about Wavedrom, it's amazing :D
@pearlboy
@pearlboy 5 месяцев назад
Excellent video
@AliG.G
@AliG.G 3 года назад
omg, this is so good. I have been looking for something to draw a timing diagram for years. Do you have anything to draw geometric diagrams especially representing angles?
@sayanee
@sayanee 3 года назад
If it's anything more complicated like geometric diagrams, I'm guessing you will have to use hand-code SVG. Maybe try d3js d3js.org/
@jeetintyagi
@jeetintyagi Год назад
Just awesome Beautiful and well explained demos Will use in my Network security blogs and diagrams
@miyukinagara
@miyukinagara 3 года назад
Your videos are always very useful. Great content !
@factorblank
@factorblank 2 года назад
Thank you for this! I recently started a new technical writing job with a team that needs their code documented and these are great tips.
@5u3r73
@5u3r73 2 года назад
Amazing tools to create technical docs! Thanks a lot for sharing, new subscriber :D
@ledric4016
@ledric4016 3 года назад
I was in need of something like this without even knowing it :D Very helpful tutorial
@TheCuteworm
@TheCuteworm 3 года назад
awesome, wish I had saw your clip year ago, so productive!
@felipequintero122
@felipequintero122 3 года назад
Great video 💚 It has given me so many ideas to implement in my ongoing projects
@lakshmiprasad4026
@lakshmiprasad4026 2 года назад
Beautifully explained!!⭐❤
@AliG.G
@AliG.G 3 года назад
OMG interactive html bom is soo cool
@victortorres2080
@victortorres2080 4 года назад
Very good. Thanks.
@sandhyaash7134
@sandhyaash7134 2 года назад
Bengali?
@sayanee
@sayanee 2 года назад
Yes, I am :)
@sandhyaash7134
@sandhyaash7134 2 года назад
dekhei bujhechi..amio didi.. nice to meet you..
@sayanee
@sayanee 2 года назад
@@sandhyaash7134 Amaro khub bhalo laglo!
@josephzakarian8645
@josephzakarian8645 2 года назад
Hey, thank you for the great video, can you please tell us the name of the book and author Documentation on your desk please. Thanks!
@sayanee
@sayanee 2 года назад
It's actually the August 2018 edition of Increment increment.com/about, a print and digital magazine by Stripe stripe.com: increment.com/documentation/
@josephzakarian8645
@josephzakarian8645 2 года назад
This is great thank you!
@DavidMeloOfficial
@DavidMeloOfficial 3 года назад
What is the colour scheme that you're using in iTerm2?
@sayanee
@sayanee 3 года назад
Oh no! I keep changing it 😅 I believe this one was either Atom or Material dark theme. Even within Atom / Material, they have variants.
@experiencedlab1969
@experiencedlab1969 3 года назад
2:20 Cool tool, but the generator on github pages doesn't support it. Fortunately, you can include a third-party template. You do not need to copy the template to your repository. 👍
@sayanee
@sayanee 3 года назад
Yeah, all the Markdown-based documentation won't be supported when you view them on GitHub or any other Markdown reader. I prefer to simply render them as a webpage / HTML and send the URL to the readers. Either way, as you mentioned there are many other options 🙏🏼 Could you give an example of a third-party template? I didn't understand that part about copying the template to my repository 😅
@experiencedlab1969
@experiencedlab1969 3 года назад
@@sayanee Yes please. Here is an example of loading a third-party template, while graphs are drawn directly on the site. github.com/kc-doam/manual/ As it turned out, in the settings not needed. *plugins:* *- jekyll-remote-theme*
Далее
Linus On LLMs For Coding
17:06
Просмотров 277 тыс.
We finally APPROVED @ZachChoi
00:31
Просмотров 7 млн
Главное рыба есть, а воды нет..
00:54
Witch changes monster hair color 👻🤣 #shorts
00:51
Software Planning and Technical Documentation
10:49
Просмотров 151 тыс.
Meet Jekyll - The Static Site Generator
21:52
Просмотров 103 тыс.
Microservices are Technical Debt
31:59
Просмотров 331 тыс.
Is Computer Science still worth it?
20:08
Просмотров 334 тыс.
The Only Markdown Crash Course You Will Ever Need
22:16
Don't Use Confluence for Technical Documentation
9:05
Просмотров 2,7 тыс.
We finally APPROVED @ZachChoi
00:31
Просмотров 7 млн