Руководство к узкоспециализированному ПО, как лицензировать?

>как вы считаете, нормальное руководство?

по моему не хватает описания самой модели

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

то что бросилось в глаза:

«дырки» — без комментариев, ты инженер или блджд кто??;

логгировать — есть русское слово, что за американизмы?;

(Иллюстрация 20), Иллюстрация 20 — почему именно Иллюстрация и почему не сократить это длииинное слово?

не понял из руководства, зачем это нужно

> логгировать — есть русское слово, что за американизмы?;

Какое?

«дырки» — без комментариев, ты инженер или блджд кто??;

А как? http://ru.wikipedia.org/wiki/Алгоритм_Уайлера_—_Атертона

(Иллюстрация 20), Иллюстрация 20 — почему именно Иллюстрация и почему не сократить это длииинное слово?

Потому что впервые верстаю в OOo что-то сложнее реферата. Потом переделаю в LaTeX как надо, но сейчас не до этого, дело срочное :).

Геокриологам (мерзлотоведам) это нужно. Есть данные о грунтах и об условиях на поверхности. Нужно понять, что будет, если сделать X (построить дом / насыпать насыпь / заложить трубу / ...), то есть что станет с мерзлотой в этом месте. Для этого применяется геокриологическое моделирование.

Вы лучше по лицензии подскажите :).

>как лицензировать?

По той же лицензии что и ПО

http://www.gnu.org/copyleft/fdl.html

Там GPL, так что логичнее GFDL.

журналировать, не?

ну напиши отверстия :)

А я думал ты знаешь разницу между рисунком и иллюстрацией. Переделай в Рис. 20. IMO

и в чём разница?

Иллюстрации

Иллюстрации в тексте или приложениях дипломной работы принято называть рисунками. К рисункам относят любой графический материал, кроме таблиц. Наиболее распространенными из них являются схемы, графики и диаграммы. Все рисунки должны иметь ссылку на них в тексте дипломной работы. Рисунки нумеруются в пределах каждого раздела, а их названия приводятся под рисунком. Все рисунки выполняются черными чернилами или пастой. Ссылка на иллюстрацию пишется в следующем виде: «… в соответствии с рис. 1.1». Иллюстрации должны иметь наименование и при необходимости пояснительные данные (подрисуночный текст). Слово «Рис.» и наименование помещают после пояснительного текста и располагают, как показано на примере.

ужасное руковдство

1) стиль изложения не тот. нужно излагать в императивном стиле.

Не

Начало и конец — это начальная и конечная дата расчётов.

А

Для задания начальной и конечной даты нажмите туда то туда то

2)Нужно излагать действия, для достижения цели которую нужно выполнить, а не описание интерфейса программы, а пока всё руководство - описание интерфейса

3) нет литературы

4) избегать американизмов «Логгирование» - бррр

5) нет отступов

6) По госту не Иллюстрация а Рисунок и к томуже по центру а не справа от картинки

7)МГУ, геологический факультет, кафедра геокриологии - пишется сверху и не так

7) лицензию лучше не пихать на первую страницу а в отдельный раздел «условия распространения»

8) в оглавлении должно быть максимум 3 уровня вложения и пронумерованы

вот только основные замечания

>Про просьбе кафедры, накатал методичку к своей программе.

Такое на кафедре не примут. Судя по всему тебя попросили позаниматься методической работой. Насколько я знаю, её суть - в написании методичек, за которые потом преподам и кафедре будут плюсики при очередных проверках/аттестациях/подведении итогов работы.

на момент начала работы над ней являвшиеся студентами кафедры

Судя по этому, ты уже похоже не студент. Но поддерживаешь контакты с кафедрой. Значит кто-то вроде соискателя-аспиранта (или сочувствующий). А для этих категорий граждан методическая работа вполне естественна и приветствуется.

В моём вузе методички все как на подбор оформляются по принятым нормам. У них есть титульник установленного образца, типографская информация. Всякие надписи типа «утверждено на заседании кафедры таком-то». А потом методичку передают на печать в типографию.
А то что ты сделал - это хелп для интернетов. По нему не отчитаешься и не получишь зачётных плюсиков. Так что моё имхо - тебя попросят немного её доделать.

Кстати, раз тебя попросили сделать методичку к своей проге, значит её (прогу) думают включить в учебный процесс.

Как такое лучше лицензировать? Вариант «никак» не предлагать.

Если ты как-то пристоен в своём ВУЗе, то твоя работа принадлежит этому ВУЗу и они при желании могут повлиять на лицензию.

> 3) нет литературы

Так она и не использовалась.

5) нет отступов

6) По госту не Иллюстрация а Рисунок и к томуже по центру а не справа от картинки

7)МГУ, геологический факультет, кафедра геокриологии - пишется сверху и не так

8) в оглавлении должно быть максимум 3 уровня вложения и пронумерованы

Это всё будет, когда переделаю в LaTeX.

> Такое на кафедре не примут. Судя по всему тебя попросили позаниматься методической работой. Насколько я знаю, её суть - в написании методичек, за которые потом преподам и кафедре будут плюсики при очередных проверках/аттестациях/подведении итогов работы.

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

> Судя по этому, ты уже похоже не студент. Но поддерживаешь контакты с кафедрой. Значит кто-то вроде соискателя-аспиранта (или сочувствующий). А для этих категорий граждан методическая работа вполне естественна и приветствуется.

Нет, второй автор не студент, уезжает в канадскую магистратуру.

Я хочу сказать, что это не то чтобы методичка, а просто руководство.

Лицензируй так, чтобы можно было свободно распространять как минимум.
С юридическим статусом Creative Commons непонятно сейчас.

И вообще, как вы считаете, нормальное руководство?

По оформлению:
Форматирование говно. Нужно внести отступы к абзацам.

По самому изложению материалов:
Нужно привести русскоязычные аналоги, приводя в скобках оригинал, если решил писать термины по-русски, иначе руководство не является завершённым. Словам типа «дырка» найди инженерно более корректную замену — это техническое руководство. В выражениях «Каждый блок имеет (теплофизические) параметры» или убирай скобки и пиши «теплофизические», либо убирай скобки и пиши: «теплофизические и иные». Или вообще строй предложение иначе, так как в противном случае изложение получается ужасным и режет глаза.

Я могу ещё многое расписать, но дам две важные рекомендации:

1. Возьми в своём вузе стандарт на оформление технической документации и оформляй текст строго в соответствии с ним.
2. Дай почитать результат тому, кто заинтересован в освоении программы (это важно, так как другой будет читать на «отвали - у меня другие дела есть», поэтому скажет, что всё нормально). И скажи ему, чтобы вообще все нарекания и претензии по тексту высказывал, любые капризы в том числе. Все замечания запиши и в разумных пределах последуй им.

gogi> Если ты как-то пристоен в своём ВУЗе, то твоя работа принадлежит этому ВУЗу и они при желании могут повлиять на лицензию.

Поправка: если эта работа делается в порядке работы в вузе.

Obey-Kun> Так она и не использовалась.

Значит сама программа - говно, которое делает свою работу по неизвестному методу, который нигде не описан, либо документация говно полное, раз на метод не ссылается.

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

А, ну на метод можно сослаться, да.

> Нужно излагать действия, для достижения цели которую нужно выполнить, а не описание интерфейса программы, а пока всё руководство - описание интерфейса

Разве я это не делаю в последней главе? Что нужно сделать человеку для задания его модели (создать блоки, отметить граничные условия и пр) — он и так знает. Я в этой главе показываю, как именно это делается в моей софтине.