TGViewer
Technical Writing 101 🇺🇦 Technical Writing 101 🇺🇦 @technical_writing · 1.45K subscribers
Post #286 76

Forwarded from Shut up and write

Мы потом напишем

«Мы потом напишем хелп/подсказки/текст в интерфейсе», — следующая по популярности фраза в моем персональном рейтинге.

Хелп, подсказки и текст в интерфейсе — это часть продукта, с которой пользователи будут взаимодействовать. Скорее они заметят ошибку в тексте, чем баг в бэкенде, тем более большинству все равно на безупречную архитектуру.
Если писать тексты потом, после дизайна и разработки, то мы можем получить сложную программу с непонятными названиями в интерфейсе. Да, хелп к такой системе будут много читать, но кому от этого легче?

Вот хорошая цитата из гайдлайна Microsoft:
«Software developers often think of text as relegated to product documentation and technical support. "First we'll write the code, and then we'll hire someone to help us explain what we have developed." Yet in reality, important text is written earlier in the process, as the UI is conceived and coded. This text is, after all, seen more frequently and by more people than perhaps any other type of technical writing.
Comprehensible text is crucial to effective UI. Professional writers and editors should work with software developers on UI text as an integral part of the design process. Have them work on text early because text problems often reveal design problems. If your team has trouble explaining a design, quite often it is the design, not the explanation, that needs improving.»
More from @technical_writing
  1. May 14, 2025📊 State of Docs 2025 is here! The State of Docs 2025 report just dropped — super interest…
  2. Jul 17, 2024🚀 Exciting update for technical writers and developers using Google Docs! 📝 Now, you can…
  3. Jun 26, 2024photo post
  4. Jan 27, 2023environmental documentation
  5. Dec 23, 2022Есть чувство, шо GitHub вот-вот перевернет рэп игру своей новой функцией Blocks. Blocks ー…
  6. Dec 22, 2022Допомоги/Підтримки пост Гайз, хочемо поділитись з вами штучним інтелектом який може створи…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →