Это мой конспект для выступления на семинаре, проводившемся нашей LUG. См. также презентацию к докладу.
Глава 1. Актуальность, цели и задачи
Вобще говоря, разработка технической документации — это достаточно обширная область. Техническая документация, по идее, прилагается чуть ли не ко всему подряд — инструкция к чайнику, проектная документация к мосту, мануал к программе. Конечно, в разных случаях аудитория у документов разная, разные и цели подготовки документации, а потому используются разные подходы. Я буду говорить в основном о подготовке документации к программным продуктам, хотя практически всё это применимо и к разработке других видов документации (хотя, вероятно, предлагаемой методики недостаточно).
Целью разработки документации к программному продукту является предоставление пользователю достаточно полной информации о продукте в том виде, в котором это удобно пользователю. Отсюда вытекают следующие задачи:
- Полная документация к большому продукту будет большой. Поэтому необходимо обеспечить автору документации простые и удобные средства для её подготовки, стараться не тратить время автора на посторонние вещи типа оформления этой документации или тонкостей xml-разметки;
- Пользователи у продукта, возможно, будут разные, а потому документацию необходимо предоставлять в разных форматах; самые популярные форматы — PDF, HTML и CHM;
- Так как пользователи разные, разной должна быть комплектация документации. В одних случаях нужно только руководство пользователя, в других — только руководство программиста, в третьих — и то, и другое.
Ниже приводится обзор различных технологий, используемых для подготовки технической документации, с оценкой их соответствия поставленным задачам, а затем предлагается собственная методика использования существующих технологий (с использованием свободного ПО).
Глава 2. Обзор технологий
Я начну с краткого обзора технологий, которые применяются для подготовки технической документации. Наиболее известны следующие технологии:
- MS Word и подобные системы;
Системы «единого источника»:
- Help&Manual и аналоги;
- DocBook;
- DITA;
- и другие.
Рассмотрим некоторые из этих технологий несколько подробнее.
Глава 3. Help&Manual
Главным плюсом этой системы часто является то, что она уже внедрена и работает. Также несомненный плюс — это система единого источника, т.е. из одного текста можно получить документ в разных форматах. Особенность этой программы и аналогов: это WISIWYG-системы. Насчёт того, является ли эта особенность плюсом или минусом, по сей день не утихают споры. Плюс WISIWYG-технологий очевиден, он заложен в названии: можно сразу видеть, как будет выглядеть текст в результате. К минусам WISIWYG относят следующие пункты:
- Есть такое высказывание: если система предоставляет возможность что-нибудь настраивать, она, фактически, заставляет вас это настраивать. В данном случае это относится к тому, что автор тратит время не только на написание текста, но и на его оформление, хотя это, по идее, не его задача.
- Такие системы склонны порождать совершенно дикую и нечитаемую разметку при конвертировании в HTML, LaTeX и другие подобные форматы. Например, легко можно получить разметку наподобие:
разметка. Это сказывается, как только появляется необходимость поправить такую разметку «руками». - При работе в таких системах люди склонны использовать не логическую, а физическую разметку (например, помечать кусок текста жирным шрифтом, вместо того чтобы отмечать этот текст как заголовок). Что интересно, большинство таких систем предоставляют возможность использования логической разметки, иногда даже удобную, но по каким-то психологическим соображениям люди не склонны её использовать. Это приводит к проблемам при изменении общего стиля оформления документа, а также зачастую при конвертировании в другие форматы.
В связи с послед
Украшаем двор пластиковыми бутылками
Сегодня, мы расскажем вам, как украшать двор пластиковыми бутылками. Обыкновенная пластиковая бутылка разлагается в течении многих десятков лет. В летние дни, семья из 3-х человек выкидывает примерно 5 пластиковых бутылок в неделю. Пластиковые бутылки легко режутся, плавятся, бывают разных цветов. Все эти факты просто кричат о том, что выбрасывать пластиковые бутылки не логично. Этот водостойкий, пластичный материал, которого в каждом доме в избытке, нужно использовать в своих целях.
Украшаем двор пластиковыми бутылками
Шторы из бус
Яркие или нейтральные, блестящие или матовые, звонкие или бесшумные, стеклянные, пластмассовые или деревянные, самодельные шторы из бус должны занять достойное место в доме творческого человека. Помните, самодельные шторы из скрепок и журналов? Очаровательные цветные занавески были во многих квартирах, в 90-х годах. Это яркий пример тому, как люди украшали свой дом используя простые? неброские предметы. Как вы наверное уже поняли, сегодня мы поговорим о самодельных шторах, но не из скрепок, а из бусин.
шторы из бус
Бижутерия своими руками. Фото
Самодельная бижутерия — это разнообразие форм размеров и способов изготовления. Украшения, изготовленные разными мастерами в одной технике, никогда не будут абсолютно одинаковыми, как не будут одинаковыми блюда, приготовленные разными поварами. Как говорится в известной пословице «Лучше один раз увидеть, чем сто раз услышать». Мы приготовили для вас специальный выпуск «Бижутерия своими руками. Фото«, в котором постарались собрать разные способы и стили изготовления украшений.
Бижутерия своими руками фото
Правильная настройка All in One SEO Pack — подробное руководство
Приветствую Вас! Без плагина All In One SEO Pack не обойтись, если Вы планируете продвигать свой блог в поисковых системах интернета. За три года с момента написания этой статьи данный плагин постоянно усовершенствовался и обновлялся. Сегодня он обладает рядом полезных функций.
Зачем нужен плагин?
- Для каждой отдельной записи на блоге можно прописать заголовок и ее описание, отображаемые в поисковой системе, а также ключевые слова для поисковых систем. Эти поля носят специально название — мета-теги title, description и keywords. Наличие этих мета-тегов на страницу с каждой статьей положительно влияет на продвижение. Плагин позволяет прописать специальный заголовок страницы специально для поисковых систем, а для красоты отображения в блоге можно написать другой заголовок.
- Можно изменить описание (description) главной страницы, ее заголовок и ключевые слова (keywords);
- Запретить индексацию рубрик, архивов, тегов с помощью noindex.
Как установить и настроить All In One SEO Pack
Заходим в раздел плагины в админке блога, вверху нажимаем на кнопку Добавить новый, в строку поиска вводите All In One SEO Pack и нажимаете Поиск плагинов. Устанавливаете и активируете плагин All In One SEO Pack.
Теперь в меню админки появится раздел «Инструменты SEO». Кликните на него, чтобы открыть настройки.
Приступим к настройке плагина. Отмечаем птичкой блок Канонические URL’ы. Теперь каждой статье будет присвоен специальный тег, который укажет поисковым роботам, что это основная страница из дублированных. Как известно древовидные комментарии создают дублированные страницы, которые обязательно нужно удалить, иначе трафика с поисковой системы Гугл Ваш блог не получит. Внимательно прочтите и примените, что написано в статье «Борьба с дублями страниц в поисковой выдаче«.
Заголовки статей составляйте сами в ручную. Поэтому менять ничего не нужно возле пункта «Выводить заголовок по умолчанию». В настройках главной страницы прописывайте заголовок сайта и его описание. На ключевые слова поисковые системы последнее время не обращают никакого внимания, поэтому там можно ничего не писать.
Далее обратите внимание на раздел настроек «Настройка заголовков». Отметьте пункты «Перезаписывать заголовки» и «Заголовки с прописной».
В настройках вебмастера я ничего не указываю. Также пропускаю раздел «Настройки сервисов Google». Ссылка, подтверждающая авторство в Гугл у меня выводится в футере. Нет смысла ее дублировать.
Ниже есть форма, в которой можно настроить индексацию рубрик, архивов и тегов. Если Вы выполнили все мои рекомендации по составлению файла роботс и закрытию дублей на блоге Wordpress, то Вам нужно вот так установить настройки индексирования:
После того, как Вы что-то поменяли в настройках, не забудьте нажать кнопку Обновить настройки.
Теперь на странице Добавить запись в самом низу можно увидеть следующую форму Инструменты SEO:
Здесь Вы можете указать заголовок, оптимизированный для поисковиков, описание к записи и необходимые ключевые слова. Напомню, что заголовок указанный в поле плагина может отличаться от заголовка, который Вы прописываете вверху поста.
Как сделать карту сайта для wordpress плагином All in One Seo Pack
Совсем недавно у All in One Seo появилась дополнительная функция, позволяющая создать карту сайта xml. А значит мы можем отключить плагин Google XML Sitemaps и сделать шаг к ускорению своего блога. Кто не знает — плагины оказывают влияние на скорость загрузки сайта. Проверить какие плагины тормозят загрузку Вашего блога поможет плагин Plugin Performance Profiler, вот ссылка на статью о нем https://inetsovety.ru/iz-za-kakogo-plagina-vash-blog-na-wordpress-dolgo-gruzitsya/
Сначала отключаем плагин google xml sitemaps.
В админке блога в левой боковой колонке найдите пункт меню Инструменты SEO и из выпадающего меню выберите «Другие модули»:
Находим модуль карты сайта xml и активируем его:
В меню появилась xml карта сайта:
Кликаем по ней и попадаем на страницу настроек. В самом верху Вы увидите предупреждение о конфликте с файлом, генерируемым плагином. Поэтому перед тем как создать sitemap xml с помощью All in One Seo Pack, удалите старый сайтмап. Можно это сделать двумя способами: соединиться с хостингом через ФТП клиент, найти и удалить их или кликнуть на кнопку «Удалить файл» под предупреждением. Я выбрала второй вариант.
Теперь настроим xml карту сайта. Чтобы в карту сайта не попадали дублированные страницы, отмечаем галочками следующие типы записей: страницы и записи. Не нужно добавлять туда рубрики и метки. Не забудьте отметить пункты: уведомлять Гугл и Бинг о изменениях в карте сайта.
Из генерируемой sitemap можно исключить отдельные страницы и даже целые рубрики вот в этом пункте:
Найти номер статьи, которую требуется исключить из карты сайта, можно открыв ее в редакторе. В адресной строке после ?post= будет ее ID. Номера исключенных страниц пишите в специальном поле через запятую.
После того, как Вы все настроили. Нажмите на голубую кнопку «Обновить карту сайта», которая есть, как вверху, так и внизу. Чтобы посмотреть, сколько страниц у Вас отображается в созданной sitemap, нажмите на ссылку «посмотреть карту».
Как видите, никаких сложностей в создании и настройке карты сайта sitemap.xml с помощью All in One Seo Pack нет. Теперь этот плагин у нас выполняет ряд важных функций: создает карту сайта, закрывает от индексации ненужные разделы сайта, выводит для поисковиков заголовок и описание статьи.
Самый оптимальный способ похудеть
Самый оптимальный способ похудеть
Многие люди недовольны своим весом и стараются всеми возможными способами сбросить лишние килограммы. Некоторые время от времени придерживаются различных диет, которые часто к сожалению дают только временный результат, т.е. пока человек на диете – вес начинает снижаться, как только диета прекращается, снова происходит повышение веса до прежнего уровня, а то и выше. Естественно, правильное и здоровое питание важно не только если вы хотите похудеть, но и для поддержания нормального обмена веществ здорового человека с нормальным весом и в нормальной физической форме. Не надо забывать о том, что существуют и другие способы реального похудения. Читать