Category Archives: документирование ПО

Техническая коммуникация и документирование ПО

Сегодня второй день Зимней Школы по программной инженерии для выпускников ВУЗов’11, на которой я представила свой доклад о технической коммуникации и документировании ПО. Презентацию можно посмотреть здесь:
Техническая коммуникация и документирование ПО.pps (PowerPoint 2003 file)

Advertisements

Leave a comment

Filed under CMS, Confluence, Документация, документирование ПО, единый источник документации, управление проектами, technical communication, technical writing, Wiki

I’m on SECR 2010!

This year I’m attending and speaking at the Software Engineering Conference taking place in Moscow, Russia.

The event is awesome. The key persons of the industry traditionally visit the event. Grady Booch, Ivar Jacobson, Lars Bak, Yuri Gurevich, Steve Masters are among the key speakers of the last years.

This time Bjarne Stroustrup comes to visit us at SECR (his program is here).

I’m looking forward to meet the icon!

My paper on ‘Supporting SaaS in Documentation Systems’ is submitted to the conference program. Yeah!

Now it’s time to prepare a presentation.

Leave a comment

Filed under CMS, Документация, документирование ПО, единый источник документации, IT conference, software documentation, tech writing, technical communication, technical writing, Wiki

Орфографический словарик: телекоммуникации

  • Демоверсия, деморежим
  • ТВ-каналы, ТВ-передачи, ТВ-программа
  • Радиоканалы
  • Караоке-запись, караоке-трансляция, караоке-клуб
  • PIN-код
  • Видеовыход
  • Видеосервер, мн. число им.п. – видеосерверы
  • Договор, мн. число им. п. – договоры
  • Фотосервис
  • Мультимедиасистема (слитно)
  • Флеш-карта, флеш-диск
  • Флешка
  • Промоакция, промосайт

Кроме того любое слово можно проверить по орфографическому словарю с помощью HTTP-запроса:

http://gramota.ru/slovari/dic/?word=<слово>&all=x

где <слово> – целое слово или его часть, нуждающаяся в проверке правописания.

1 Comment

Filed under Документация, документирование ПО, software documentation

Tekom – Great Community for Technical Communicators

Today I have discovered a large international community for technical communicators – Tekom. It seems to be interesting. It performs conferences and exibitions, accredits educational course providers and does much more work on promoting our proffession – technical writer.
Tekom is a German organization. It has a bunch of useful articles on the official web site (English version is available): Tekom.de

Truly, it would be awesome to take part in the annual Tekom’s conference on technical communication. Anyone can send an interesting article or presentation to introduce at the conference.

Unfortunately, the paper submission deadline has already passed in this year (13 March). However, we can just attend the event in this year:)
This year Tekom’s conference will be hold from 3 to 5 November 2010 in Rhein-Main-Hallen, Wiesbaden.
For more information about the conference, see tcworld 2010 conference.

As I found Tekom I think about possible opportunities of improving my tech writing and communication skills. I search Tekom’s web site for learning courses and professional certifications, but found nothing.

Can anyone advice any certification programs? Which are the best and well-known? Where to go to advance professional skills in technical writing?

Leave a comment

Filed under документирование ПО, IT conference, software documentation, tech writing, technical communication, technical writing

Documentation in Agile Projects

I have an idea of preparing a report for SEC(R) 2010 about how to use Wikis for software and software project documentation getting the maximal profits from this technology. Wikis are the most suitable instrument for agile projects, where developers should rogirously economy resources and spend so little time for documentation as possible.
I would like to demonstrate all principles of effective agile documentation in the Confluence wiki system.

So, the questions are:
Is such a subject really interesting and possible to demonstrate to the public?
What aspects would you like to see and find out from this report?

SEC(R) stands for Software Engineering Conference (Russia), it is an annual conference with English and Russian speakers describing and discussing various issues of software engineering and development.

SEC(R) 2010 (Russian version of the web site, English version is under construction)
SEC(R) 2009 (English version of the web site created for the previous conference)

1 Comment

Filed under документирование ПО, project management, software documentation, tech writing, technical writing

Книги по документированию ПО на русском

На русском языке о документировании ПО написано мало. До сих пор мне попадалось очень мало книг, посвященных данной теме, и я решила составить их список с кратким резюме по каждой из них:

  1. Ю.В. Кагарлицкий. Разработка документации пользователя программного продукта. Полезна начинающему техническому писателю, которому впервые поручили написать пользовательскую справку, или человеку, начинающему работать с документацией. Содержит рекомендации по стилю изложения, советы по написанию максимально полезного и понятного хелпа.
  2. В. Глаголев. Разработка технической документации. Перечисляет системы стандартов, которые используют при документировании ПО, как старые советские (ЕСПД), так и относительно новые (ИСО). Книга в основном пересказывает стандарты и может быть полезна техническому писателю, работа которого жестко регламентирована требованиями ГОСТов, или писателю, желающему расширить свои знания о процессе разработки документации. Книга сложновата для восприятия.
  3. Липаев В.В. Документирование сложных программных средств. Монография, кратко описывающая процесс документирования, стандарты в области управления качеством, которые можно применить к документации. В книге рассматриваются вопросы организации процесса, необходимые условия работы, виды шаблонов документов, ответственности всех участников разработки ПО в документировании продукта. Книга написана довольно сложным для восприятия языком.

1 Comment

Filed under Документация, документирование ПО, technical communication, technical writing

Introduction to Software Documentation

Recently I was delivering a report on software documentation to my groupmates at the university, who are also employed in IT industry, about the latest trends in our professional area.

The report proved to be interesting. So I decided to extend it by adding some more information, which will be useful for beginners getting started in technical writing.

The presentation contains:

  • What kinds of technical documentation exist
  • What are documentation standards
  • Code documentation tools roadmap
  • Documentation techniques and tools overview
  • Doc styling approaches
  • Some useful recommendations of hep writing

… and so on

The presentation peculiarities:

  • It was prepared for russian audiency, so it has some local-specific information. However, you are free to skip reading it and you will not miss any useful info all the same.
  • The presentation contains two slides describing case studies I was delivering during the report. Do not pay attention to them 🙂

The presentation is available here Introduction to Software Documentation.pdf

Leave a comment

Filed under Документация, документирование ПО, software documentation, technical writing