система для ведения заметок
Alexander Orlov
Hемного не по теме конференции, но...
В общем, в ходе поддержки и разработки софта с многомегабайтными исходниками
периодически возникают "открытия", которые бы хотелось оставить для истории.
Hапример, "ба, да обработка событий данного типа осуществляется там-то и
так-то, причем необходимо не забыть учесть то-то и то-то".
Вопрос, как эти "открытия" сохранять :)
Записывать на бумажку? Теряются?
Сохранять просто в текстовые файлики? Hе очень-то удобно.
Кто чем пользуеться для подобных целей?
Есть идея установить на локальном серваке что-то типа wiki, но там система
создания ссылок между страничками не очень подходящая (если не ошибаюсь,
ключевое слово должно состоять из двух слов, записанных слитно, каждое
записанно с большой буквы, что для лиспа, например, очень плохо подходит; могу
ошибаться, это мои смутные воспоминания). Да и с поиском по этой базе данных
как-то не очень понятно. Опыт подсказывает, что найти что-то в wiki обычно
далеко не простая задача, если не знаешь совершенно точно, что ищешь
(правильное ключевое слово).
Alexander
Sergey P. Derevyago
> Hемного не по теме конференции, но...
> В общем, в ходе поддержки и разработки софта с многомегабайтными исходниками
> периодически возникают "открытия", которые бы хотелось оставить для истории.
> Hапример, "ба, да обработка событий данного типа осуществляется там-то и
> так-то, причем необходимо не забыть учесть то-то и то-то".
> Вопрос, как эти "открытия" сохранять :)
>
данных. Т.е. фактически, ты имеешь в голове некую модель системы и хотел бы
сохранить некоторые ее детали. Детали достаточно мелкие, чтобы не удержаться
надежно в оперативной памяти.
Хороших баз знаний не существует хотя бы потому, что разные люди держат в
голове разные модели одних и тех же систем (по разному проложены связи, разным
фактам придается разное значение). Вероятно, можно создать достаточно удобную
базу знаний для личного использования, но она будет малополезна для остальных
членов команды.
Опять же, не вполне понятно по каким критериям будет работать поиск.
Идеальный вариант: диалог с человеком. Ты задаешь более-менее определенный
вопрос, собеседник начинает задавать уточняющие и/или наводящие вопросы для
уяснения чего же тебе на самом деле нужно, а не что ты там только что
пробормотал.
Короче, для действительно сложных систем все достаточно сложно. Ну а для
простых IMHO вполне хватает привычных комментариев по сырцу.
> Записывать на бумажку? Теряются?
> Сохранять просто в текстовые файлики? Hе очень-то удобно.
> Кто чем пользуеться для подобных целей?
>
... и чем оно лучше привычных заметок на полях?
--
С уважением, Сергей. http://ders.angen.net/
mailto:ders?skeptik.net
Alex Mizrahi
(you :wrote :to '(All) :on '(Fri, 14 Oct 2005 13:10:34 +0400))
(
AO> Есть идея установить на локальном серваке что-то типа wiki, но там
AO> системасоздания ссылок между страничками не очень подходящая
это смотря какое вики..
само по себе оно, конечно, не организуется, но если немного продумать
(например, разделы, ключевые слова, условные обозначения) -- то получится
вполне себе.
AO> понятно. Опыт подсказывает, что найти что-то в wiki обычнодалеко не
AO> простая задача, если не знаешь совершенно точно, что ищешь(правильное
AO> ключевое слово).
ну не знаю, я обычно нахожу даже то что не искал 8], хотя для работы я вики
серьёзно не использовал. (были попытки внедрить, но особых активистов не
нашлось, и оно заглохло).
)
(With-best-regards '(Alex Mizrahi) :aka 'killer_storm)
"People who lust for the Feel of keys on their fingertips (c) Inity")
Vladimir Kirichenko
AM> это смотря какое вики..
mediawiki. В последнее время появилось очень много
сайтов даже в снаружу на mediawiki. Как конкретные
примеры это kb.mozillazine, opensuse, mono.
--
Best Regards,
Vladimir Kirichenko
Отправлено через сервер Форумы@mail.ru - http://talk.mail.ru
Alexander Krotov
AO> Записывать на бумажку? Теряются?
AO> Сохранять просто в текстовые файлики? Hе очень-то удобно.
AO> Кто чем пользуеться для подобных целей?
Пробовал Knowit, MindManager и PersonalBrain.
Из перечисленного только Knowit прижился, хотя и
ненадолго - проект недоработан и в последнее время
не развивается.
Alexander Orlov
AO>> Записывать на бумажку? Теряются?
AO>> Сохранять просто в текстовые файлики? Hе очень-то удобно.
AO>> Кто чем пользуеться для подобных целей?
AK> Пробовал Knowit, MindManager и PersonalBrain.
AK> Из перечисленного только Knowit прижился, хотя и
AK> ненадолго - проект недоработан и в последнее время
AK> не развивается.
From http://knowit.sourceforge.net
5th October 2005: Development resumed!
Спасибо всем за наводки, буду смотреть.
Alexander
Nikita V. Belenki
AO> Hемного не по теме конференции, но...
AO> В общем, в ходе поддержки и разработки софта с многомегабайтными
AO> исходниками периодически возникают "открытия", которые бы
AO> хотелось оставить для истории.
AO> Hапример, "ба, да обработка событий данного типа осуществляется там-то и
AO> так-то, причем необходимо не забыть учесть то-то и то-то".
AO> Вопрос, как эти "открытия" сохранять :)
AO> Записывать на бумажку? Теряются?
AO> Сохранять просто в текстовые файлики? Hе очень-то удобно.
AO> Кто чем пользуеться для подобных целей?
Вопрос по теме, и время от времени задаётся. Hо идеального ответа на него нет.
Возможные варианты:
1. Комментарии в коде, код под системой контроля версий.
2. Отдельные текстовые файлы в проекте, под общей системой контроля версий с
кодом.
3. Email (архивируемый список рассылки или public folder[s]).
4. Если рассматривать каждое такое "открытие" как основание для улучшения кода
и/или документации, то, соответственно, их можно проводить через багтрекер.
Возможна комбинация этих вариантов, но при этом нужно держаться формально
расписанного техпроцесса, а то потом запаритесь искать, какое "открытие",
описанное одним вариантом, соответствует какому, описанному другим.
AO> Есть идея установить на локальном серваке что-то типа wiki,
А чем wiki в этом применении лучше текстовых файлов?
Kit.
Alexander Orlov
AO>> Есть идея установить на локальном серваке что-то типа wiki,
NB> А чем wiki в этом применении лучше текстовых файлов?
Главным образом, возможностью создания удобных перекрестных ссылок на другие
заметки.
Alexander
Nikita V. Belenki
AO>>> Есть идея установить на локальном серваке что-то типа wiki,
NB>> А чем wiki в этом применении лучше текстовых файлов?
AO> Главным образом, возможностью создания удобных перекрестных ссылок на
AO> другие заметки.
А смысл - в этом применении? Прямые ссылки всё равно обычно ведут в исходники
(а также почту, трекер и прочее не подконтрольное вики), а для обратных grep
ничуть не хуже.
Kit.
john gladkih
> AO>>> Есть идея установить на локальном серваке что-то типа wiki,
> NB>> А чем wiki в этом применении лучше текстовых файлов?
> AO> Главным образом, возможностью создания удобных перекрестных ссылок на
> AO> другие заметки.
>
> А смысл - в этом применении? Прямые ссылки всё равно обычно ведут в исходники
> (а также почту, трекер и прочее не подконтрольное вики), а для обратных grep
> ничуть не хуже.
>
чем плохо писать комментарии под doxygen и иметь все перекрестно
и с самими исходниками?
--
john, http://john.kak-sam.to
Serhiy Storchaka
Этот день нужно отметить красным в календаре -- джон о чём-то отозвался
положительно. ;)
--
С уважением.
Сергей Сторчака
john gladkih
>>> AO>>> Есть идея установить на локальном серваке что-то типа wiki,
>>> NB>> А чем wiki в этом применении лучше текстовых файлов?
>>> AO> Главным образом, возможностью создания удобных перекрестных ссылок на
>>> AO> другие заметки.
>>>
>>>А смысл - в этом применении? Прямые ссылки всё равно обычно ведут в исходники
>>>(а также почту, трекер и прочее не подконтрольное вики), а для обратных grep
>>>ничуть не хуже.
>> чем плохо писать комментарии под doxygen и иметь все перекрестно
>> и с самими исходниками?
>
> Этот день нужно отметить красным в календаре -- джон о чём-то отозвался
> положительно. ;)
я пока еще только задал вопрос.
--
john, http://john.kak-sam.to
Nikita V. Belenki
>> AO>>> Есть идея установить на локальном серваке что-то типа wiki,
>> NB>> А чем wiki в этом применении лучше текстовых файлов?
>> AO> Главным образом, возможностью создания удобных перекрестных ссылок на
>> AO> другие заметки.
>> А смысл - в этом применении? Прямые ссылки всё равно обычно ведут в
>> исходники (а также почту, трекер и прочее не подконтрольное вики), а для
>> обратных grep ничуть не хуже.
jg> чем плохо писать комментарии под doxygen и иметь все перекрестно
jg> и с самими исходниками?
А doxygen умеет автоматически строить индексы ссылок на документируемые
объекты?
В смысле, аналоги такому в вики:
<http://en.wikipedia.org/wiki/Special:Whatlinkshere/Doxygen>
Kit.
Sergey P. Derevyago
> А doxygen умеет автоматически строить индексы ссылок на документируемые
> объекты?
>
здесь: http://ders.angen.net/cpp3/intmsg/doc/classCException.html
Nikita V. Belenki
>> А doxygen умеет автоматически строить индексы ссылок на документируемые
>> объекты?
SPD> Автоматически создает "Перекрестные ссылки", можешь посмотреть,
SPD> например, здесь:
SPD> http://ders.angen.net/cpp3/intmsg/doc/classCException.html
Я не про ссылки в код, а про обратные ссылки в документацию. Если я оформляю
заметку о некоем баге в Foo(), делающем невозможным использование Foo()
совместно с Bar(), как комментарий в отдельном файле, мне на этот комментарий
будут ссылки из документации по Foo() и Bar()?
Kit.
Sergey P. Derevyago
> Я не про ссылки в код, а про обратные ссылки в документацию. Если я оформляю
> заметку о некоем баге в Foo(), делающем невозможным использование Foo()
> совместно с Bar(), как комментарий в отдельном файле, мне на этот комментарий
> будут ссылки из документации по Foo() и Bar()?
>
И это правильно, т.к. в противном случае возле каждого ключевого объекта
(вроде тельца функции) паслось бы просто ОГРОМНОЕ количество мусорных ссылок,
оно надо?
Alex Mizrahi
(you :wrote :to '(Nikita V. Belenki) :on '(Fri, 21 Oct 2005 09:00:23 +0000
(UTC)))
(
??>> Я не про ссылки в код, а про обратные ссылки в документацию. Если я
??>> оформляю заметку о некоем баге в Foo(), делающем невозможным
??>> использование Foo() совместно с Bar(), как комментарий в отдельном
??>> файле, мне на этот комментарий будут ссылки из документации по Foo() и
??>> Bar()?
SPD> Без твоего явного запроса -- вряд ли.
SPD> И это правильно, т.к. в противном случае возле каждого ключевого
SPD> объекта (вроде тельца функции) паслось бы просто ОГРОМНОЕ количество
SPD> мусорных ссылок, оно надо?
с чего бы они там паслись?
а вообще в профайлерах есть такая штука -- who-calls. иногда очень полезно
знать, при рефакторинге, например -- какие части затронет рефакторинг.