Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
   RSS
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
Выкладываем в этой теме примеры и ссылки на хорошую техническую документацию
Страницы: Пред. 1 2
Ответить
Ответы
 


.... Лучше писать документацию на каком-то одном языке, и не делать ошибок.

Scaner => Scanner
Radio-telefon => Cordless telephone
Presence sensor => Occupancy sensor (скорее всего)

RJ-45 это не интерфейс передачи данных, а вид разъема с 8-позиционным 8-контактным коннектором.

Что изображено рядом с надписью Pilot, мне непонятно. Я знаю не знаю ни одного подходящего значения слова Pilot.
Возможно, вместо надписи Pilot следует написать Surge protector.

Кроме того, стандартное напряжение электрической сети в России не 220 V, а 230 V, согласно ГОСТ 29322-92.
Изменено: Виктор Фигурнов - 27.07.2015 19:43:00
 
Спасибо за критику, что посчитал нужным, то исправил. PS: ненавижу свою первую училку, которая в детстве записала на немецкий язык...




 
Изменено: Andreyka - 28.07.2015 11:55:25
 
Всё-таки слово "telefon" не исправили. Такого слова в английском языке нет. Это всё равно что по русски написать "тилепон".
Слово "scaner" в одном месте поправили, в другом нет.
Сокращение "WLAN" в одном месте написано с ошибкой "WPAN"
Нетбуки не производятся примерно с 2011 года.
В электрических схемах >> означает разъем, вставленный в розетку, между ними линия не допустима.


Что означают перечеркивания линий электропитания, которые вы нарисовали, мне не известно.
Две концентрические окружности на электрической схеме это не украшение, а символ электрической машины. С какой стати она нужна, не понятно.
Это домашний офис на двух автономных генераторах, что ли?
 
ТАК И ЕСТЬ))) WPAN(Wireless Personal Area Network) - беспроводная
сеть, предназначенная для организации беспроводной связи между
различного типа устройствами на ограниченной площади (например, в рамках
квартиры, офисного рабочего места).
Тут ошибки нет.

PS: Что до остального, я не государственный стандарт нарисовал и мне за это не платят и деньги не снимают, но за критику спасибо.
Изменено: Andreyka - 28.07.2015 13:29:14
 
1) Я перечеркнутой линией хотел показать отсоединяемый разъем провода на 230 вольт.
2) Электропитание от двух разных розеток... Кстати я не знаю как тройники нарисовать.
3) ... и вместо phone лучше написать "нофелет" и выпить рюмочку для профилактики)))
 
     Нет желания проводить бесплатную пропаганду своих решений и схем
Изменено: Andreyka - 05.10.2017 22:32:27 (Нет желания проводить бесплатную пропаганду своих решений и схем)
 
Chart on e-Commerce_B2C - Business-to-Consumer
Изменено: Andreyka - 05.10.2017 22:32:50 (Нет желания проводить бесплатную пропаганду своих решений и схем)
 
A friendly user manual for Samsung smart phone:

https://www.youtube.com/watch?v=cYfSKGjHBKg
 
а как составить документацию на постоянно развивающееся моб.приложение? Пытаюсь сделать все по ГОСТам. НО только успеешь что-то поправить, утрясти, как выходят новые фичи, и все это надо вносить в документацию... Уже сомневаюсь, по ГОСТам ли надо делать, или просто, придерживаясь основных требований, дать волю..
Изменено: starkovden - 12.01.2018 14:57:15
 
Если это пользовательская документация, то зачем ГОСты? Себе жизнь усложняете. Делайте по корпоративным стандартам.
 
Цитата
'''''writer''''' Zakharenko написал:
Если это пользовательская документация, то зачем ГОСты? Себе жизнь усложняете. Делайте по корпоративным стандартам.
Это внутренняя документация. Руководство поставило задачу провести экспертизу всех документов, написанных ранее (а там сплошной цирк и половина отсутствует), вот и хочется все привести к одному стандарту. Захотели ГОСТ, чтобы был паспорт, формуляр и т.д.... Но как сделать конечную документацию, если процесс разработки бесконечный, вот мучающий вопрос  :)  
Изменено: starkovden - 12.01.2018 16:44:43
Страницы: Пред. 1 2
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить