Об авторе

Разрешите представиться: меня зовут Наталия (на Гитхабе я authoress), я технический писатель в IT-сфере. Пишу техническую документацию с 2007 года.

Работала в разных компаниях: маленьких, средних, больших. Писала самую разную документацию на русском и на английском языках: руководства пользователей, документацию по ГОСТу, технические задания, Release notes и многое другое.

На сегодняшний день пишу техническую документацию для разработчиков в Лаборатории Касперского. Кроме того, пишу и перевожу документацию, которую вы можете увидеть здесь, на GeekWriter. Все, что размещено на этом сайте, написано или переведено в первую очередь для себя: я сама пользуюсь теми инструментами, о которых здесь написано.

Что помогает мне при разработке документации:

  • Python. Его я активно и с большим удовольствием использую в своей работе. Например, документация, которую я пишу для GeekWriter, создана с помощью генератора документации Sphinx, который написан на Python и широко используется для документирования проектов на Python.

  • Опыт переводов. Периодически я перевожу техническую документацию, в основном с английского на русский. Примеры вы можете найти на GeekWriter: Beautiful Soup, Alabaster.

  • Опыт веб-разработки. Это то, с чего я когда-то начинала: делала статические веб-сайты, работала менеджером по поддержке и продвижению сайтов. В моем активе, как правило, есть один-два сайта или веб-приложения, которые я развиваю и поддерживаю. Поскольку львиная доля документации сейчас хранится в интернете, опыт веб-разработки очень помогает мне в моей работе.

Если у вас остались ко мне вопросы, пишите на geekwriter@yandex.ru.