Принципы разработки документации к программному обеспечению

Под программным обеспечением обычно понимается некоторая совокупность программных средств, предназначенных для решения определённого круга задач. Программный продукт - это конкретная программа или программный комплекс.

В состав технической документации как правило входят две основные части:

• Руководство пользователя (User's Guide), описание наиболее типичных пользовательских задач, ориентированное в основном на начинающих пользователей.
• Справочник пользователя (User's Reference), полное описание функциональности продукта.

Эти части могут существовать и в интегрированном виде.

Существует несколько сценариев использования документации пользователем:

• "Быстрый старт", т.е. поиск сведений об установке, настройке, запуске и начале работы с программным продуктом.
• Ознакомительное чтение для освоения продукта в целом, решения наиболее типичных задач.
• Целевой поиск путей решения той или иной задачи.
• Целевой запрос справочной информации по избранной функции или элементу интерфейса программы.
• Методическое освоение программного продукта, детальное знакомство со всеми нюансами его работы.

Пользователь вправе рассчитывать, что следуя любому из этих сценариев, он быстро сможет отыскать нужную ему информацию.

Парсинг файла MLG (журнал регистрации 1С:Предприятие 7.7)

(С) Код не мой, где взял не помню :) Полежит тут на память.

1С 7.7: вывод прайс-листа в 2 и более колонок

Задача: В 1С 7.7 экономить бумагу, печатая прай-лист в несколько колонок.

Решение: Весь прайс с группами, элементами и даже нумерацией строк выгружаем в таблицу значений (в примере генерится таблица на 500 элементов). Высота первой и последующих страниц задается отдельно..
Текст обработки под катом.

p.s. чёт валялось в черновиках с 2016

Ошибка: "Your system administrator has disabled windows features"

Проблема: When attempting to access "Turn Windows features on or off" in Win 7 you get the error "Your system administrator has disabled windows features"

Решение: Поправить в реестре HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Programs значение "NoWindowsFeatures" на "0".

Follow-up issue: If Windows features comes up blank, run the System Update Readiness Tool for Windows 7. If you are on POSReady 7, this won't work as nothing is supposed to show (unless you've installed a new version of IE, then that version of IE will be the only thing to show)

Источники:
http://dthatcher.blogspot.com/2014/05/error-your-system-administrator-has.html
http://forum.ixbt.com/topic.cgi?id=22:76801
http://forum.ru-board.com/topic.cgi?forum=62&topic=17935
https://www.raymond.cc/blog/fix-blank-or-empty-list-in-vista-turn-windows-features-on-or-off-optionalfeaturesexe/
http://forum.oszone.net/thread-160839.html

Ошибка открытия файлов Exсel, загруженных из интернет

Проблема: При открытии файлов, загруженных, например, из хранилища BitBucket, Exсel 2013/2016 выдаёт ошибку "Файл поврежден, поэтому его нельзя открыть".

Решение: Все загружаемые файлы из интернета имеют блокировку в "Свойства":

Для работы необходимо его предварительно разблокировать, нажав на кнопку "Разблокировать".

Источник:
Ошибка при открытии файлов Exсel
2010 - [решено] Не открываются файлы, скачанные с интернета

Оттуда же - вдруг кому не помогло, можно попробовать изменить доверенные расположения.

1С 7.7: вывод таблицы с сеткой цветов

Для отображения на экране возможных вариантов выделения цветом текста/фона в ячейках печатных форм:

Процедура ПриОткрытии()
    таб = СоздатьОбъект("Таблица");
    таб.ИсходнаяТаблица("Таблица");
    сч = 0;
    Для R=1 По 255  Цикл
        R=R+9;
        таб.ВывестиСекцию("строка|старт");
        Состояние(""+R+"/255");
        Для G=1 По 255  Цикл
            G=G+9;
            таб.ВывестиСекцию("строка|старт");
            Для B=1 По 255  Цикл
                B=B+9;
                Цвет = R * 65536 + G*256 + B;
                выбСекция=таб.ПолучитьСекцию("строка|база");
                выбОбласть=выбСекция.Область();
                выбОбласть.ЦветТекста(Цвет);
                таб.ПрисоединитьСекцию(выбСекция);
            КонецЦикла;
        КонецЦикла;
    КонецЦикла;
    таб.Показать();
    СтатусВозврата(0);
КонецПроцедуры

В ячейке таблицы [строка+база] должно быть следующее выражение:

""+R+РазделительСтрок+G+РазделительСтрок+B

Вы вошли в систему с временным профилем в Windows

Проблема: Иногда после некорректного завершения работы системы при входе пользователь получает сообщение о том, что "Вы вошли в систему с временным профилем" в Windows 10, 8 и Windows 7 с дополнительным текстом «Вы не можете получить доступ к своим файлам, и файлы, созданные в этом профиле, будут удалены при выходе из системы».

Решение:

1. Войти в систему под учётной записью администратора, отличающейся от той учётной записи, в которой есть проблема
2. Сохранить все полезные данные из профиля проблемного пользователя в другую папку. 
3. Удалить папку профиля  проблемного пользователя (радикально, но легче вернуть назад любимые обои, чем ловить странные глюки).
4. Запустить редактор реестра и перейти к разделу HKEY_LOCAL_MACHINE\ SOFTWARE\ Microsoft\ Windows NT\ CurrentVersion\ ProfileList
5. Удалить в нем как подраздел, заканчивающийся на .bak, так и раздел проблемного пользователя (см. по имени в пути + я бы хорошо бы удалить ещё и все остальные устаревшие)
6. Закрыть редактор реестра, перезагрузить компьютер и зайти под учётной записью, с которой была проблема.

Источники: Раз и два.

UPD. И три. Поиск подвёл :)

Узнать в 1С номер недели в месяце по указанной дате

Задача: Узнать в 1С номер недели в месяце по указанной дате

Решение: Получаем разницу номеров недели в году текущей даты и даты начала месяца.
Рассматривается  здесь и здесь.


В запросе 1С 8.х:

НЕДЕЛЯ(Таблица.НашаДата) - НЕДЕЛЯ(НАЧАЛОПЕРИОДА(Таблица.НашаДата, МЕСЯЦ)) + 1

Для 1С 7.7
НомерТекущейНедели = НомерНеделиГода(НашаДата) - НомерНеделиГода(НачМесяца(НашаДата)) + 1;

Служебная страница about:about в Mozilla Firefox

About:About

В этом списке для вашего удобства перечислены страницы «about».
Некоторые из них могут поставить вас в тупик. Некоторые используются исключительно в целях диагностики.
А некоторые пропущены, так как для своей работы требуют параметров запроса.
Описание тут: https://developer.mozilla.org/en-US/Firefox/The_about_protocol

Оказывается все давно известно :)

https://habrahabr.ru/post/255345/

Не открываются файлы MSC

Проблема: ОС Windows 2003 Server, при попытке открытия любой оснастки появляется ошибка - "MMC не может открыть файл ... .msc. Возможно файл отсутствует, не является консолью MMC, или был создан более поздней версией MMC. Также возможно отсутствуют права на открытие данного файла". (или англ. "MMC cannot open the file C:\WINDOWS\system32\что-то там.msc")
Файл по указанному расположению присутствует, права доступа в порядке, проверка системных файлов ошибок не находит.
Если запустить mmc.exe, далее выбрать "Добавить/удалить оснастку" - любая оснастка - открывается нормально, однако сохранить её не удастся.

Решение:
regsvr32 C:\Windows\System32\msxml3.dll

Источники:
Слетела консоль управления (MMC)
When I tried to open Device Manager or the Computer Management window, I received an error message: "MMC cannot open the file C:\WINDOWS\system32\devmgmt.msc"
Службы - MMC не может открыть файл compmgmt.msc

Неправильно работает разрешение имён

Проблема: Команда nslookup отрабатывает нормально, однако ping по имени - не работает (по IP-адресу - нормально).

Решение:

Если эта команда работает:

     ping -4 yandex.ru

То, отключить IPv6.

Подробней здесь: NSLookup works but ping, tracert etc. can't do name resolution  

UPD. Из ссылки на Microsoft: "net stop dnscache worked for me"

Мне помог простой рестарт службы dnscache.

Источники:
Проблема с DNS: имена резолвятся только через nslookup
Как корректно отключить IPv6 в Windows 7 и Windows Vista

На память:

SQL Server 2008 R2 Best Practices Analyzer

Утилита проверяет SQL Server на предмет соответствия набору правил и выдаёт набор рекомендаций. Поддерживаются SQL Server 2008 и SQL Server 2008 R2. BPA ставится отдельно от SQL Server и для своей работы требует Microsoft Baseline Configuration Analyzer 2.0 и Powershell 2.0. Скачать BPA можно здесь - Best Practices Analyzer.

Статья по теме.

Windows 10 + SSD

Оптимизация настроек Windows 10 для работы SSD диска

Настройка SSD для Windows 10

Настройка SSD диска в Windows для оптимизации работы

Автоматическое появление сенсорной клавиатуры на рабочем столе в планшете с Windows 10

Рецепт здесь.
"На рабочем столе, в отличие от планшетного интерфейса, с настройками по умолчанию при попадании в фокус текстового поля (вроде адресной панели браузера или документа Word) экранная клавиатура не появляется автоматически; чтобы открыть её, нужно нажать на иконку клавиатуры в системном трее. Для автоматической активации экранной клавиатуры на рабочем столе:
1. Открыть в меню «Пуск» Параметры -> Устройства -> Ввод.
2. Активировать переключатель Автоматическое отображение сенсорной клавиатуры в оконных приложениях при отсутствии подключенной к устройству клавиатуры."

Задаем настройки прокси-сервера с помощью групповых политик домена Windows server 2008 R2

Копия статьи.

Появилась необходимость задать настройки прокси-сервера для пользователей. Т.к. все ПК находятся в домене, логично задать настройки прокси-сервера путем Групповых политик домена. Имеется домен контроллер на базе Windows server 2008 R2. Но как выяснилось в Windows Server 2008 R2 возможность настройки Internet Explorer только версий 5,6,7,8. Для старших версий настройки не применятся.

Поэтому нужно придумать универсальное решение для всех версий браузеров, используя GPO. И решение было найдено, путем изменения параметров реестра на рабочих станциях пользователей.

Группы Windows NT и Active Directory

Копия одноименной статьи  на память и на случай возможного удаления оригинала :)
Очень познавательно.

Устранение ошибки 13.A2.FF принтера HP M603

Проблема: Принтер HP M603 при печати с нижнего лотка останавливается с ошибкой 13.A2.FF, лист бумаги застряет в 100% случаев в момент подачи.

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

Learn to floss the PS102 and PS103 sensors to remove paper jams on LaserJet M600 series printers, including M601, M602, and M603.

Небольшой тюнинг Избранного и окон диалога Открыть/Сохранить как

В левой части окна Проводника находится список «Избранное». В этот список по-умолчанию добавляются ссылки на определенные папки (например, «Рабочий стол»), а также на папки некоторых программ (Google Drive, Dropbox, Яндекс.Диск и др.).
В список «Избранное» легко можно добавить другие папки, простым "перетаскиванием" с помощью мыши.

Решение чтобы добавить файлы - здесь.

Чтобы настроить окна "Открыть" и "Сохранить как" для ускорения навигации, можно воспользоваться редактором групповой политики gpedit.msc.
Открываем его, далее выбираем "Конфигурация пользователя - Административные шаблоны - Компоненты Windows - Проводник Windows - Общее диалоговое окно открытия файлов - Элементы, отображаемые в панели мест". Включаем политику и прописываем от 1 до 5 ссылок.
Вместо gpedit можно воспользоваться редактором реестра, рецепт здесь.

Периодическое аварийное завершение проводника Windows

Проблема: Периодически при открытии папки или при очистке корзины Windows Explorer аварийно прекращает работу. Это может происходить раз в неделю, а может буквально каждые 5 — 10 минут.

Решение:  Windows 7: Windows Explorer crash — how to fix it


В 99% случаях виноваты дополнения к Windows Explorer, которые разные приложения ставят в систему. Это те самые пункты меню, которые появляются по клику правой кнопкой мышки.

Последовательность действий, которая поможет исправить ситуацию:
1. Для начала необходимо скачать утилиту: ShellExView — Shell Extensions Manager, которая позволяет управлять этими расширениями.

2. Запускаем утилиту с правами администратора, сортируем список дополнений по имени компании разработчика.

3. Отключаем все дополнения, у которых производитель не Microsoft.
4. После проделанных операций перегружаем компьютер и работаем некоторое время без дополнений. Если аварийные завершения Проводника не повторяются, по одному включаем действительно нужные дополнения, например, «Notepad++» или «7-zip» и некоторое время мониторим работу компьютера.

Параметры состояния и события apcupsd

Отсюда.