Как мы делаем справку для Renga
2017-08-18 13:15:01
... своим пользователям качественную
документацию. И мы, ... , хочется, чтобы
документация не отставала от ...
+ развернуть текст сохранённая копия
Как правило, каждый разработчик программного обеспечения хочет предоставить своим пользователям качественную документацию. И мы, компания Renga Software, не исключение.
В этой статье я, технический писатель Renga Software Анастасия Тян, расскажу, от чего мы отталкивались в начале разработки справки для BIM-системы Renga и к чему в итоге пришли.
Итак, пользователи наших продуктов ― архитекторы, проектировщики и конструкторы. Для них был разработан минималистичный интерфейс Renga, состоящий всего из нескольких панелей и рабочего пространства, ограниченного лишь размерами мониторов. Разумеется, хочется, чтобы документация не отставала от интерфейса в оформлении, а также предоставляла пользователям всю необходимую информацию.
С самого начала разработки Renga было понятно, что нам необходима современная онлайн-справка. Также было принято решение, что мы не будем отказываться от оффлайн-справки в формате CHM, чтобы пользователи могли к ней обращаться без подключения к интернету и не тонуть в ворохе html-файлов. Читать дальше →
Тэги:
flare,
html,
madcap,
mercurial,
renga,
teamcity,
аскон,
блог,
веб-сайтов,
документация,
компании,
разработка,
справка
Документация для ReActions (и вообще…)
2017-05-06 21:12:25
... разные движки для
документации. Хотел сделать двуязычный ...
+ развернуть текст сохранённая копия
Долго перебирал разные движки для документации. Хотел сделать двуязычный сайт, чтобы после добавления материала на одном языке, соответствующая страница создавалась бы для другого и её оставалось бы только перевести. Увы, такого движка я так и не нашёл. Желаемый функционал сводится к ручному повторению структуры либо к такому танцу с бубнами с конфигурациями, что просто не […]
Тэги:
reactions,
документация,
плагины
Документы для строительства дома
2016-10-17 04:32:02
Какие документы нужны для строительства частного дома Желающие построить свой собственный дом должны ...
+ развернуть текст сохранённая копия
Какие документы нужны для строительства частного дома Желающие построить свой собственный дом должны знать, что в их жизни наступает этап, связанный с постоянными хлопотами и стрессами. Особенно это касается тех, кто не имеет элементарного понятия, как можно без особых моральных и материальных потерь выполнить эту задачу. Большинство из них не имеют представления, о том какие […]
Тэги:
документация,
документы,
дома,
строительства
Документы для газификации
2016-10-14 11:20:21
Какие документы нужны для газификации частного дома Осуществление газификации частного дома является ...
+ развернуть текст сохранённая копия
Какие документы нужны для газификации частного дома Осуществление газификации частного дома является довольно сложным процессом, поэтому, прежде чем его начать, следует определить, с какой нужно инстанции начать и какие документы для этого приготовить. С чего начать газификацию частного дома Нужно первоначально определить собственника газопровода, который может решить вопрос относительно врезки. Затем следует посетить проектную организацию, […]
Тэги:
газификации,
документация,
документы
Frontend: Разработка и поддержка
2016-09-06 13:24:09
< ...
+ развернуть текст сохранённая копия
Давайте представим, что вас перевели на новый проект. Или вы сменили работу и о проекте максимум только слышали. Вот вы садитесь за рабочее место, к вам приходит менеджер, жмёт руку и… прямо сходу открывает страницу проекта, тыкает пальцем в монитор и просит вставить «информер о предстоящем событии Х». На этом вы расстаётесь… Что делать? С чего начать? Как создать «информер»? Где найти нужный шаблон? И море других вопросов.
Под катом будет рассказ, как мы стараемся организовать эти процессы, какие инструменты создаём для препарирования SPA. Кроме этого, мы поговорим о технических подробностях реализации Live Coding / Hot Reload и чуток о VirtualDom и React с Angular.
Читать дальше →
Тэги:
group,
javascript,
mail.ru,
блог,
веб-сайтов,
документация,
инструменты,
компании,
процессы,
разработка
