Viết tài liệu đặc tả chức năng (FSD) sao cho hiệu quả?
Nhiều Founder và PM đang tranh luận về việc cân bằng giữa độ chi tiết và tốc độ phát triển:
- Mục tiêu: Giữ FSD hữu ích mà không làm chậm tiến độ team dev.
- Câu hỏi lớn: Đâu là phần bắt buộc (must-have) và đâu là phần có thể bỏ qua ở giai đoạn đầu?
- Thách thức: Tránh việc viết quá sơ sài gây hiểu lầm hoặc quá chi tiết gây lãng phí thời gian.
#FSD #ProductManagement #SaaS #BuildInPublic #QuanLySanPham #PMRole #StartupViet #TechDoc
https
Ever wonder how DeepMind went from teaching an AI to play Pong to predicting protein folding? 🤯 Their 2024 Tribeca doc, 'The Thinking Game,' is now free to watch!
What's the most mind-bending AI breakthrough you've witnessed?
#AI #DeepMind #TechDoc #MachineLearning #TechNews
https://www.engadget.com/ai/you-can-now-watch-a-google-deepmind-doc-for-free-184911659.html?src=rss
»In the old days, technical writers produced documentation in near isolation, surrounded by complex and similarly isolated corporate cultures. From an anthropological perspective, old manuals are like tribal artefacts. The resulting docs show surprisingly rich design and content patterns, more refreshing than we’re used to in the age of googling for Stack Exchange questions and of bowing to Stripe docs.«
https://passo.uno/why-collect-read-old-computer-manuals/ #vintagecomputing #techhistory #techdoc
Möchte jemand für dieses überaus berechtigte Anliegen noch etwas über 2500 Stimmen hierfür "finden", wie man das seit einiger Zeit wohl nennt? ;-)
Danke für's Beachten und nach Belieben unterstützen:
Mehr Infos auch beim #vgsd : https://www.vgsd.de/mit-regelmaessigen-updatespetition-aktivrente-auch-fuer-selbststaendige-jetzt-mitzeichnen/
Danke!
Schreibst du öfter mal technische Dokumentationen, RTFMs oder READMEs? Dann ist dieser Artikel für dich!
„Über example.com und das Schreiben von technischer Dokumentation“
https://www.unixe.de/techdocs/
Edit: Ergänzt um die „Drama Numbers“ der Bundesnetzagentur.
Edit: Ergänzt um Autonomous System Numbers
Eingeschobene Nebensätze kann man fast immer vermeiden und den Satz mit wenig Aufwand so umstellen, dass es ein nachgestellter Nebensatz wird. Damit wird auch das Leseverständnis deutlich verbessert. #justsayin #techdoc
Hi technical communicators and editors/translators in technical documentation, I'd like to point you towards an open TC textbook that I've been made aware of: https://digitalcommons.kennesaw.edu/opentc/ (free PDF or available in print for small money - in the US). It's CC-BY licensed, too!
Liebe Menschen, die ihr Dokumentation schreibt, in denen IP-Adressen vorkommen: Wusstet ihr, dass es RFCs gibt, die IP-Adress-Blöcke speziell für den Gebrauch in Dokumentation definieren? Wenn dann jemand aus eurer Doku Copy & Paste macht ohne nachzudenken, kann nicht viel passieren, außer dass die Person sich schlimmstenfalls das eigene Setup zerkonfiguriert. Wer das genauer wissen muss, wirft bitte mal einen Blick in RFC 5737 (IPv4), RFC 3849 (IPv6) und RFC 2606 (Domain-Namen). #techdoc
Никаких инструкций. Советы от техписа о том, как обойтись без него
Привет, меня зовут Евгения Береснева, и я старший технический писатель в X5 Tech. Пожалуй, выглядит странным, что технический писатель пишет статью с таким названием. Так что для начала небольшой дисклеймер: — Нет, мы не боимся остаться без работы. В любой крупной IT-компании потенциальных задач для техписов всегда так много, что столько сотрудников невозможно нанять, да и найти на рынке не так-то просто. — Советы из статьи можно применить лишь к ограниченному числу сервисов, остальные всё равно нуждаются в инструкциях. Итак, вы готовитесь выпустить в мир IT-продуктов новый классный сервис. Конечно, стоит рассказать вашим пользователям о том, как эта штука работает. Даже к самому простому стулу из IKEA есть инструкция, а ваш сервис, наверняка, посложнее стула. Но по каким-то причинам вы не можете привлечь технического писателя, чтобы он написал инструкцию. Ну что ж, есть и другие варианты.
https://habr.com/ru/companies/X5Tech/articles/782366/
#usability #techdoc #технический_писатель #инструкции #интерфейсы #техническая_документация #приложения
ℹ️ Da mir gerade ein Kunde vom Haken ist: Ich hätte diese und nächste Woche plötzlich Zeit, für euch bzw. euer Unternehmen #techdoc und/oder #marketing collateral zu übersetzen (#xl8) bzw. Software zu lokalisieren (#l10n):
🇬🇧/🇫🇷 ➡️ 🇩🇪 oder 🇩🇪 ➡️ 🇬🇧/🇫🇷
Fachgebiete: #maschinenbau #anlagenbau #automation #industrie40 #cloud B2B #software (PaaS / SaaS) und #kunststoffe #plastics
While writing our free Linux Course, I realized that after adding information to already existing parts it has to be put in the right order, because knowledge builds up on what one has already learned in previous chapters #writer #techdoc #knowledge #free
#asciidoc wants to become an open specification using the Eclipse Foundation Specification Process: https://asciidoctor.org/news/2019/01/07/asciidoc-spec-proposal/ #news #techdoc
