powered by simpleCommunicator - 2.0.61     © 2026 Programmizd 02
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Форумы / Microsoft Access [игнор отключен] [закрыт для гостей] / Napisanie itogovoy dokumentatsii po proektu
25 сообщений из 25, страница 1 из 1
Napisanie itogovoy dokumentatsii po proektu
    #32294523
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Podskazhite chayniku kak pisat' itogovuyu dokumentatsiyu (user manual) po Access prilozheniyu.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294531
incold
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Без грамматических ошибок
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294536
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Ochen' ostroumno, a glavnoe polezno.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294539
Фотография Geo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Тут мно-о-о-ого про это говорили :)\r
/topic/23646
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294543
incold
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
2 pravda
Какой вопрос, такой ответ.

Вопрос можно понять как:
1. Какие инструментальные средства использовать для написания документации
2. Какие основные разделы должны присутствовать в документации
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294547
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Spasibo. Ochen' del'no.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294550
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Incold ,To to i ono i, chto ya chaynik i na dannom etape ne obladayu znaniyami, chtobi pravil'no sformulirovat' vopros.
Spasibo za podderzhku, tol'ko nemnogo otpugivaet.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294559
incold
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Даже если чайник, это не мешает нормально задать вопрос, достаточно взглянуть на свой текст со стороны, или просто представить как такой вопрос воспримет человек, который не знаком с текущим состоянием дел у задающего вопрос.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294565
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Incold:

Ochen' ubeditel'no, a glavnoe tollerantno.
Ne vse otlichayutsya umom i soobrazitel'nostyu, no vot terpeniem ne meshalob zapastis', esli pomogaesh' ot dushi.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294576
incold
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Ладно не буду спорить.
Терпение, это нужная вещь, но на всех его не хватает, а посетителей форума много
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294579
Фотография Владимир Саныч
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Модератор форума
Мне кажется, что написание документации - это самостоятельная отрасль искусства. Первый вопрос - это для кого предназначена документация, для разработчиков ли или для пользователей. Вопрос, на чем написана система (Аксесс ли, или ассемблер, или еще что-нибудь), к разработке документации не имеет отношения.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294586
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
spasibo za poyasnenie.
Dokumentatsiya prednaznachena dlya pol'zovateley.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294606
Фотография Нуф-нуф
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Если документация для пользователей, то лучшим вариантом, ИМХО, является контектно-зависимая документация.
За свою короткую жисть я очень редко встречал юзера, читающего мануалы по прогам. Но зато очень часто видел (наверно потому что сам писал такие мануалы), как юзеры попав в незнакомую форму или диалог жмут F1 (даже на бумажечке записывают: "F1 в самом верху - справка"). Нет, F1 оно и в африке F1, но надо сделать контекстно-зависимую F1 - справочный файл открывается в разделе, который описывает всё то, с чем связана данная форма/диалог. Таким образом совсем не обязательно писать вступление, благодарности, называть главы и разделы, а просто описать каждую форму. //Сорри, если слишком подробно ;)

Ну а на счет реализации, то в самом простейшем случае, для мини-проектов с мини-справкой/подсказкой, храни и отображай справочную информацию подручными средствами самого Access - таблицы, формы, отчеты. Так ты сэкономишь время на "въезжание" в help-овые заморочки. Если же справка должна содержать картинки, ссылки на другие разделы справки, отображаться в стандартных хелповых окошках и т.п., то прямой путь тебе к поиску прог, генерящих help-файлы...

Я так думаю...
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294620
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
bol'shoe spasibo za detal'niy otvet.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294668
Фотография Geo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
2Нуф-Нуф
Юзер привыкает к тому, чему ты его учишь (о чем ты его предупреждаешь).
Скажешь: "Скажу один раз, передавайте из уст в уста", - Будешь развивать его память, ибо он действительно все запомнит.

Напишешь краткое руководство по основным функциям акцеса (поле со списком/перебор записей/принципы сохранения изменений) - будет следовать им.

Напишешь подробнейшее "руководство пользователя", тем более в виде контекстно зависимой справки - очень хорошо.

---

Но все равно, при первом же ЧП ищется ближайший виновник, от которого будет наименьшее количество вреда. Если ты написал программу, а тем более ты в штате, а тем более не поставил юзера на его юзерское место еще при знакомстве - виновным быть тебе. Да. И справка тут не при чем.

Проходили уже.

---

И-эх.. Дарроги...
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294670
Фотография Geo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ЗЫ. Ни разу не читал справку по виндам и почти половину того, что знаю про акцес, узнал без книжек и форума. Хотя в языках априоре хелп не должен быть равен хелпу прикладных программ.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294683
Фотография Нуф-нуф
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Geo, в том то и дело, что есть большая разница между "мануалом" и "хелпом".

Мануалы, эдакие произведения, с последовательным изложением, которые никто из юзеров не читает. Именно поэтому для пользователей даже не стоит и рыпаться писать "мануал" - все равно читать не будут! А вот хелп, или как бы контекстно-зависимый "мануал", должен быть обязательно! Ну нельзя ассоциировать в программе кнопку F3 с Формой3, F2 с Формой2, а F1... с Формой1! %) Видел такой шедевр... Когда нажал энту кнопку и выскочила какая-то форма я сначала долго соображал, а потом у меня истерика началась

Мануалы для программеров - дело другое. Они (в разных эпостасиях - книги, например, тоже "мануалы") необходимы, ибо просто по хелпам очень тяжко "сконструировать" реляционную БД не имея теории. Ну есть Джет, ну свойства и методы у него какие-то... А как всё это в одну кучу собрать - ХЗ.

Чё та я нить потерял... К чему я это всё? Хм... Перетрудился, млин... Щаз такую хрень пытаюсь сотворить, что если скажу, то весь форум уписяется Мозги дымятся уже... Ладно. Пусть будет. Не удалять же? :)

А на счет нахождения крайнего в твоем (моем) лице, то это даже не плохо! Я щас в ПТ прочитал прикол-не прикол, фик знает, что в какой-то западной конторе человек пять дней (!) просидел за столом в мертвом (!!!) состоянии!!!!!! Т.е. сердце прихватило, он скончался прям на рабочем месте и ПЯТЬ ДНЕЙ в ОБЩЕМ ОФИСЕ на кажется 20 человек никто не заметил!!! Трындец... Но вывод там классный - нефик работать до поздна, сё равно никто не заметит, что ты работаешь. ...или не работаешь.
Такие дела
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294687
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Spasibo vsem, rasskazhite pozhaluysta chto soboy predstavlyaet kontekstnozavisimiy manual?
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294696
Фотография Geo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
> нельзя ассоциировать в программе кнопку F3 с Формой3, F2 с Формой2, а F1... с Формой1

Да в том то и дело, что можно. Как можно и в дос посадить пользователей. И так им это преподнести, что они тебе еще спасибо лет пять говорить будут. Хотя это дело, наверное, дело менеджеров больше. А можно пользуясь тем, что есть, написать интуитивно понятную штуку. За которую лет пятнадцать благодарить станут. Хотя это, наверное, забота психологов/дизайнеров больше.

А мануалы/хелпы/причиндалы - это требования, спускаемые сверху. Как бы это изъяснить. "лидер", "личность", черт-те-кто. Как "командир" скажет, так и будет. Скажет, читайте до посинения 5 страниц - выучат наизусть. Скажет - трясите этого, - будут трясти.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294699
pravda
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Spasibo za pomoshch'.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32294736
Фотография Alexander G
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Если документация для юзеров, то тут можно встретить 2 подхода - тупое описание экранных форм и менюшек (я зверею, когда вижу такое, утрируя -это описание, к примеру, молотка, без объяснения как забить гвоздь :)
Как мне кажется, более правилен другой подход - описание решения задач (на примерах), для которых предназначено приложение.
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32295425
Фотография Нуф-нуф
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
для Alexander G:
Не знаю почему, но твой пост я увидел в своем огороде :) Может быть потому, что лично я всегда практиковал "тупое описание экранных форм". А может быть потому, что практически рекомендовал этот способ выше :)

Итак, создавая "тупое описание экранной формы" я описывал практически все элементы на форме в виде:
- Что это такое;
- Для чего и когда это нужно;
- Как с этим работать (если требуется);
- Дополнительная информация;
- Ссылка на теоретический раздел (очень редко).

Такое описание не заставляло меня писать труды, а потом с трудом заставлять людей эти труды читать - один черт (в моей практике) их никто не читал!

На счет "молотка" и "гвоздей"... Вот я попадаю в столярный цех вообще без каких-либо навыков и знаний в области забивания гвоздей. Вот я жму F1 и мне начинают рассказывать теорию о забивании гвоздей - бить молотком по гвоздю только его центром, иначе гвоздь согнется. Если гвоздь согнулся, то надо развернуть молоток обратной стороной и выдернуть гвоздь... Теория с примерами, с чертежами гвоздей, приложения к ним внешней силы и математическими формулами из физики и сапромата :) Ну и что? А за какую сторону (если у него вообще есть стороны) взять молоток? А каким инструментом держать гвоздь? Что?! Пальцами?!!! Нет уж... И негде будет прочитать, что инструментом для "держания" гвоздей во время забивания может служить плоскогубцы или... рассческа :)

Более того, теория - и есть теория! Даже в неком узком направлении теория так и остается теорией, а практические инструменты меняются от одного конкретного случая к другому. Если я умею водить машину, то я владею теорией вождения автомобиля, что совсем не означает, что я смогу хотябы "завести" луноход! А че? Тоже транспорт... Но инструменты управления абсолютно иные! Тоже самое с молотком и гвоздями... Вот ты прочитал теорию где даже картинки есть - молоток нарисован, как держать нарисовано и т.п., а дали тебе... пневматический молоток. Вроде тоже из теории забивания гвоздей, но только инструмент то другой! Ну и что? Ты будешь его об гвозди лупить? Ведь теорию забивания гвоздей мы выучили

Нисколько не умаляя значение теории как таковой, всё же выскажу свое личное мнение, что прежде чем подходить к программе, юзер должен владеть необходимыми теоретическими знаниями - бухгалтер должен знать бухгалтерию, секретарь - делопроизводство, а набиватель накладных - должен уметь читать сей документ. На сколько я знаю, ни одна бухгалтерская программа не учит в хелпах своих пользователей предмету "Бухгалтерия", а просто описывает то, какими инструментами в программе можно добиться того, чего бухгалтер добиться желает. Т.е. на лицо "тупое описание экранных форм и меню". И лично я тебе не завидую, если для каждого нового проекта тебе приходится писать фундаментальный труд о теории предмета учета твоей программы в цветных картинках. И не завидую пользователям твоих программ, если они прочитав этот фундаментальный труд так и не знают, какую же кнопочку надо ткнуть, чтобы закрыть окошко. Или, с другой стороны, если твоим пользователям приходится прочитать весь твой фундаментальный труд только для того, чтобы узнать что же делает та самая кнопочка с крестиком :)

Я тоже утрирую, но тем не менее вот мой взгляд на вещи... А камушек заберите... Заберите говорю! Я из них себе дом уже построил и двор ими выложил, больше не надо :)
---------------------
- Чукча, на тебе бензопилу - лес быстрее пилить будешь!
- Ай сипасиба, аднака!
...спустя время...
- Ну что, Чукча, бысрее лес валить с бинзопилой?
- Быстрее аднака! Зубцики острые, аднака! Тока, аднака, тязелый сибка...
- Ну так мотор ведь у нее железный, конечно потяжелее будет чем обычная!
- А у нее и мотор есть аднака?!!!
//еееех... детства золотая :)
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32296036
Фотография Alexander G
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Вроде не кидал, я вообще стараюсь не раскидываться, аккуратненько положил возле себя, да и маленький он, не не очень страшненький :)
Для тривиальных задач вроде ввода платежек и накладных :) и документация не нужна, правильно расставленные хинты и интуитивно понятный интерфейс все сделают сами и никто в этом случае читать доку не будет, а если заказчик требует, можно сделать и документацию по принципу описания форм, проблем не возникнет.
Но иногда этого недостаточно.
Первый раз я с этим столкнулся 13 лет назад. Есть такая программа Surfer - визуализация данных (построение изолиний, поверхностей и т.д.), неплохая программа. Перевел хелп, а он тогда был именно по принципу описания меню и форм (у нынешних версий он вроде поприличнее). Юзеры достали, все профи, эти задачи на бумаге и калькуляторе делали свободно, на компьютере более или менее научились работать, а тут затык, что нужно, понимают, а сделать не могут, не описаны подходы и связи между блоками ввода, обсчета и визуализации. Пришлось сделать документацию, как решать типовые задачи.
Впоследствии сталкивался с этим несколько раз, в основном на заказных разработках для малорапространенных задач.

А про теорию пользования инструментом вообще я вроде и не говорил, нужно описание пользования именно данным инструментом, молотком просто, пневматическим молотком и т.д. :)
Если более предметно - сколько раз случалось, присылают к нам новую модель агрегата, к примеру дизель-генератора, мы имеем представление о них, рядом вон крутятся. Но начинаем с чтения документации, она обычно написана нормально - цена ошибки высока - запороть дизель, если бы ее составляли по принципу описания кнопок и ручек, тяжко бы нам пришлось.
А в программах - да подумаешь, документ улетел, новый набьют...

А камешек лежит возле меня, пощупал, вот он, никуда я его не кидал!
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32296061
Фотография Alexander G
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
А про анекдот-то бородатый и забыл :)
Привезли лесопилку импортную пилу
собрались рабочие, сунули в нее доску.
Вжик! - сказала пила
О! мля -сказали рабочие и сунули брус
Вжиик! - сказала пила
О! мля -сказали рабочие и сунули бревно
Вжиииик! - сказала пила
О! мля -сказали рабочие и сунули рельс
Хрррр... - сказала пила
A! мля -сказали рабочие
...
Рейтинг: 0 / 0
Napisanie itogovoy dokumentatsii po proektu
    #32296096
Фотография Нуф-нуф
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Согласен... Случаи бывают разные :)
...
Рейтинг: 0 / 0
25 сообщений из 25, страница 1 из 1
Форумы / Microsoft Access [игнор отключен] [закрыт для гостей] / Napisanie itogovoy dokumentatsii po proektu
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]