Size: a a a

technicalwriters

2020 December 15

FM

Fox Mulder in technicalwriters
Roht
по крайней мере, сорстри я пользую лет пять, но аккаунта в битбакет у меня так и нет
Сейчас проверю, раньше было обязательно.
источник

FM

Fox Mulder in technicalwriters
Nick Volynkin
я использую git alias:
log --color --graph --abbrev-commit --all --pretty=format:'%Cred%h%Creset -%C(yellow bold)%d%Creset %s %Cgreen(%cr) %C(blue)<%an>%Creset'


А если хочется сильно подробнее и чтобы включать-выключать ветки, то Git-плагин в IDEA.
Ну так се результат
источник

FM

Fox Mulder in technicalwriters
Roht
sourcetree
Оказалось что результат по визуализации не сильно лучше git bash gui ((
источник

IK

Ivan Kochurkin in technicalwriters
Nick Volynkin
А, ещё ссылки стараюсь выносить на отдельную строку. То есть
текст текст текст
[текст ссылки...](https://example.com)
дальше текст
А не рассматривал такой вариант:

текст текст текст
[текст ссылки...
](https://example.com)
дальше текст

Так по идее еще лучше с точки зрения дифа, если ссылки часто меняются.
источник

NV

Nick Volynkin in technicalwriters
Ivan Kochurkin
А не рассматривал такой вариант:

текст текст текст
[текст ссылки...
](https://example.com)
дальше текст

Так по идее еще лучше с точки зрения дифа, если ссылки часто меняются.
не рассматривал, но мне нравится такой вариант
Ссылки не обязательно часто меняются, но и текстовую часть, и URL сильно удобнее читать с начала строки.
источник

ET

Eduard Tibet in technicalwriters
Елизавета Тальянова
да
в курсовой в прошлом году анализировала гифки на сайте notion
название «анализ использования изображения формата gif в технической документации»
У вас гифки именно на предмет их анимированности? Или просто как формат?
источник

ЕТ

Елизавета Тальянова... in technicalwriters
у меня гифки как формат визуализации в инструкциях
источник

ЕТ

Елизавета Тальянова... in technicalwriters
спасибо всем большое!
образовалась огромная почва для исследования
источник

АА

Анна Анна in technicalwriters
У кого-нибудь есть шаблон ТЗ на ПО по госту 19.201
источник

BF

Bobba Fett in technicalwriters
Yuri Dobrev
а я не люблю гифки, потому что их нельзя поставить на паузу и рассмотреть отдельный кадр. одно время тестировщики в жыре стали прикреплять гифки вместо видосов, это был кошмар. не успел заметить что-то - смотри еще раз
Любой инструмент нужно использовать по назначению. Гифки в документации не предназначены в качестве замены видео, где много разных действий и важной информации. Они подходят для иллюстрации одного или парочки простых действий, в которых не нужно нигде останавливаться: “Жмакай сюда и тяни туда” (ооо вот теперь понятно)
источник

BF

Bobba Fett in technicalwriters
Но вообще гифки тоже можно вставлять по-разному, не все знают, что они не обязаны быть зациклены, они могут фризиться на последнем кадре, они могут не запускаться сразу, а только по клику и так же по клику останавливаться, причём на предопределённом кадре (например, где самый важный момент запечатлён)
источник

ET

Eduard Tibet in technicalwriters
Елизавета Тальянова
у меня гифки как формат визуализации в инструкциях
Лучше все-же переформулировать, если не было приказа о назначении тем диссертацией. Что-то типа,    "использование элементов графики с встроенной поддержкой кадров для иллюстрации возможностей программныъ (или других) продуктов". С гифками - конечно, тема в политехе пройдет, но именно за эту формулировку потом будет немного стыдно :)
источник

ЕТ

Елизавета Тальянова... in technicalwriters
насчёт приказа ещё не знаю
обязательно подумаю, спасибо большое!
источник

OA

Olga Alexeeva in technicalwriters
всем привет) подскажите, пожалуйста, что обычно пишут в разделе "Подготовка к испытаниям" в программе и методике приемочных испытаний?
ругост и прочие сайты не помогли, нужны прям реальные примеры
источник

v

vladimir in technicalwriters
было относительно доработки существующего функционала.
я отталкивался от того, что не хочу описывать, то что не является предметом доработки функционала и описано в общем руководстве.
фраза типа "обязательным условием проведения испытаний является загрузка или создание примера самостоятельно"
источник

ZL

Zlata Lupilina in technicalwriters
Дарья Чернавина
Очень грустно это читать, ибо сталкиваюсь примерно с теми же проблемами. Скажем так, в современной журналистике и маркетинге мне не нравится существенное искажение информации, а я сама очень плохо подхожу для патетики в этих областях, чтобы сочно и задорно впарить дичь. Зато я хорошо умею разбираться в сложных темах, структурировать информацию и выдавать её понятным, но суховатым языком. А ещё я люблю писать и люблю технологии, хотела бы способствовать в какой-то мере техническому прогрессу и просвещению людей. Это именно идеалистические мечты и какая-то ценностная мотивация. Примерно такая же мотивация у меня была при поступлении на ФЖ после школы: связать экспертов и общество, доносить и распространяется знания, важную информацию. Я понимаю, что все это розовые очки, которые разобьются в любой профессии. Однако технические тексты, в моем представлении, менее ангажированы: не надо продвигать те или иные политические силы со страниц своего издания, не надо впаривать какую-то ненужную дичь или писать hate speech. Есть устройство или ПО, есть вот такие-то характеристики. Понятно, что разработчики будут просить не описывать что-то, а менеджеры будут просить. Что тоже есть заинтересованные стороны. Но даже сама форма документации, стиль того, как пишутся тексты предполагает в меньшей степени, что ты будешь на кого-то воздействовать эмоциональными эпитетами (есть и такое, но я против такого). Как говорили аналитические философы, лучше не использовать слова "скоро", "тепло" и прочие вещи, которые вызывают разночтения, споры и простор для манипуляций. Вместо «скоро» —конкретный временной интервал, вместо «тепло» — конкретный температурный режим. Я ещё долго могу писать о таком, экзистециальном...
Как то по желанию понятно доносить и структурировать информацию ещё напоминает деятельность методиста e-learning...  Может стоит зайти оттуда? Ну или посмотреть как правильно продать себя в резюме.... (К сожалению по опыту могу сказать что 90% даже очень классных спецов писать резюме не умеют :-( ) Посмотрите когда-то была неплохая подборка статей о том как это делается https://t.me/AnalyticsHumor/300
источник

НО

Наталья Орлова... in technicalwriters
Olga Alexeeva
всем привет) подскажите, пожалуйста, что обычно пишут в разделе "Подготовка к испытаниям" в программе и методике приемочных испытаний?
ругост и прочие сайты не помогли, нужны прям реальные примеры
Должен существовать, например, юзер с учеткой незаблокированной, подтвержденным мылом, непустой корзиной, деньгами на счету. Должен существовать руководитель юзера. Должен существовать бюджетный период ,активный на момент проведения испытаний. Что-то вот такое.
источник

МД

Максим Дунаевский... in technicalwriters
Olga Alexeeva
всем привет) подскажите, пожалуйста, что обычно пишут в разделе "Подготовка к испытаниям" в программе и методике приемочных испытаний?
ругост и прочие сайты не помогли, нужны прям реальные примеры
В моём случае были описаны процедуры настройки стендов: параметры установки ОС, конфигурация установленного софта, объем оперативной памяти и т. д.
источник
2020 December 16

ДЧ

Дарья Чернавина... in technicalwriters
Zlata Lupilina
Как то по желанию понятно доносить и структурировать информацию ещё напоминает деятельность методиста e-learning...  Может стоит зайти оттуда? Ну или посмотреть как правильно продать себя в резюме.... (К сожалению по опыту могу сказать что 90% даже очень классных спецов писать резюме не умеют :-( ) Посмотрите когда-то была неплохая подборка статей о том как это делается https://t.me/AnalyticsHumor/300
Благодарю 🙂
источник

OR

Olga Rodina in technicalwriters
Olga Alexeeva
всем привет) подскажите, пожалуйста, что обычно пишут в разделе "Подготовка к испытаниям" в программе и методике приемочных испытаний?
ругост и прочие сайты не помогли, нужны прям реальные примеры
мы такое пишем:

4.2.1 Подготовка к испытаниям
Подготовка к предварительным испытаниям включает в себя:
  определение состава приемочной комиссии;
  распределение ответственности членов приемочной комиссии за проведение проверок и оформление результатов в Протоколе предварительных испытаний;
  ознакомление членов приемочной комиссии с Программой и методикой предварительных испытаний, документацией на оборудование и программные средства Системы;
  согласование даты и периода времени проведения испытаний, составление плана проведения испытаний;
  проведение инструктажа членов приемочной комиссии по технике безопасности при проведении испытаний.
источник