Отличия документации, книг, журналов и комментариев
От: velkin Удмуртия http://blogs.rsdn.org/effective/
Дата: 15.01.22 09:10
Оценка: -1 :)

Отличия содержимого


1) Тип содержимого.
2) Шаблоны содержимого.
3) Общая тематика.
4) Объём содержимого.

Тип Шаблоны Общность Объём
Документация Да Да Большой
Книга Нет Да Большой
Журнал Нет Нет Средний
Комментарий Нет Нет Малый

Документация


Документа́ция — это совокупность документов. Документирование — процесс отбора, классификации, использования и распространения документов. Работа с документацией часто встречается в сфере услуг и образования, особенно если речь идёт о преподавателях, заведующих библиотеками школ и училищ, у которых преобладает педагогический уклон в сфере поиска и использования информации.


https://upload.wikimedia.org/wikipedia/commons/thumb/f/f9/Bonanjo_-_Centre_de_documentation_et_information_urbanisme_%28CUD%29_03.JPG/180px-Bonanjo_-_Centre_de_documentation_et_information_urbanisme_%28CUD%29_03.JPG

Шаблоны содержимого документов


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

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

Лучший формат для личной базы знаний


Формат документации без сомнения является лучшим форматом для личной базы знаний. Лучше, чем книга, журнал или тем более комментарии так же являющиеся краткими заметками. Попытка использовать что-то другое может вылиться в разочарование ведения личной базы знаний, что в итоге приведёт к её забрасыванию.

Новая эра личных баз знаний
Автор: velkin
Дата: 14.01.22


Наивный пример шаблона содержимого класса


Ключевое отличие от книжного и журнального формата в отсутствии полей описания.
-Заголовок класса
-Тематический список
--Тема1
---Свойство1
---Свойство2
---Метод1
---Метод2
---Метод3
--Тема2
---Свойство3
---Метод4

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

Комбинированный вариант содержимого.
-Заголовок класса
-Описание класса
-Тематический список
--Тема1
---Свойство1
---Свойство2
---Метод1
---Метод2
---Метод3
--Тема2
---Свойство3
---Метод4

1) Описательные вставки можно разложить в структуру шаблона.
2) И напротив структуру шаблона объединить в описание.

Класс "Заголовок класса" содержит "Свойство1" и "Свойство2", а так же методы "Метод1", "Метод2" и "Метод3" относящиеся к "Теме1". Так же стоит отметить, что "Свойство3" и "Метод4" принадлежат "Теме2". Вызывая "Метод1" мы обращаемся к...

Книга


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

https://upload.wikimedia.org/wikipedia/commons/thumb/e/e4/Biblioth%C3%A8que_chateau_breteuil.jpg/168px-Biblioth%C3%A8que_chateau_breteuil.jpg

Разделы книги


1) Обложка (начало).
2) Титульный лист (краткое описание книги).
3) Оглавление (название глав).
4) Содержание (название глав и параграфов).
5) Содержимое (главы со вложенными параграфами).
6) Обложка (конец).

Это моё упрощённое видение разделов некой абстрактной книги. В книгах так же могут присутствовать другие элементы.

Книги бывают


1) Бумажные.
2) Электронные.

В бумажном дополнительно требуются конструктивные элементы скрепляющие книгу.

Из каких частей состоит печатная книга
  иллюстрация
https://partnerkis.ru/wp-content/uploads/2018/01/Kak-ustroena-kniga.jpg

Нисходящая книжная иерархия


Книжная серия — это книги позиционированные автором как составляющие единую последовательность.

Том (греч. τόμος — часть, отрезок) — книга как отдельная единица, самостоятельная часть многотомного или продолжающегося печатного издания.

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

Параграф (от греч. παράγραφος «написанное рядом») — часть текста внутри раздела книги, статьи или документа, содержащая законченное положение или правило и имеющая самостоятельное значение.

Абза́ц (нем. Absatz «раздел, часть текста») — отрезок письменной речи, состоящий из одного или нескольких предложений.
Примечание: в html тегом <p> называют абзац, а не параграф.

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

Сло́во — одна из основных структурных единиц языка, которая служит для именования предметов, их качеств, характеристик и взаимодействий, мнимых и отвлечённых понятий, а также для служебных целей.


Журнал


Журна́л (фр. journal — дневник, подённая записка, от фр. jour — день, сутки) — печатное или электронное периодическое издание,


Если главными элементами книг являются главы со вложенными параграфами, то журнал преимущественно состоит из статей разной тематической направленности.

https://upload.wikimedia.org/wikipedia/commons/thumb/8/84/Raquel_Jacob%27s_cover_of_Playboy_Poland_by_photographer_Ana_Dias.jpg/168px-Raquel_Jacob%27s_cover_of_Playboy_Poland_by_photographer_Ana_Dias.jpg

Как и книги журнал может быть


1) Бумажным.
2) Электронным.

Блоги


Блог (англ. blog, от web log — интернет-журнал событий, интернет-дневник, онлайн-дневник) — веб-сайт, основное содержимое которого — регулярно добавляемые пользователем записи, содержащие текст, изображения или мультимедиа.


Блоги так же являются журналами или лучше сказать электронной версией журналов.

Электронные блоги бывают


1) Частными.
2) Коллективными.

Пример коллективных блогов


1) Говнохабр.
2) Цукерберг позвонит
3) Живой журнал

Качество содержимого сайтов


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

Статьи же пишут журналюги и хорошо, если они не начинают рассказывать о себе любимом. Этим грешат даже многие авторы книг по программированию. Материал, который вы сейчас читаете это тоже статья журнального формата.

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

Комментарий


Коммента́рий (лат. commentārius — заметки, записки, толкование) — пояснения к тексту.

Коммент (англ. comment — комментарий) — комментарий к посту в ЖЖ или любом другом сайте эпохи веб 2.0.


Нужны ли комментарии и оценки на информационном сайте
Автор: velkin
Дата: 28.12.21


https://upload.wikimedia.org/wikipedia/commons/thumb/f/ff/%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9_%D0%98%D0%BD%D0%BD%D0%BE%D0%BA%D0%B5%D0%BD%D1%82%D0%B8%D1%8F_%D0%A8%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%82%D0%B0_%D0%B2_%D0%A4%D0%B5%D0%B9%D1%81%D0%B1%D1%83%D0%BA.png/320px-%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9_%D0%98%D0%BD%D0%BD%D0%BE%D0%BA%D0%B5%D0%BD%D1%82%D0%B8%D1%8F_%D0%A8%D0%B5%D1%80%D0%B5%D0%BC%D0%B5%D1%82%D0%B0_%D0%B2_%D0%A4%D0%B5%D0%B9%D1%81%D0%B1%D1%83%D0%BA.png

Худшее содержимое


С точки зрения полезной информационной наполненности комментарии являются худшим представителем.

1) В среднем самый малый объём из всех типов содержимого.
2) Каждый комментарий может содержать несколько тем, что хуже статьи журнала.
3) Содержимое комментариев часто не продумано в отличие от содержимого книг.
4) В комментариях так же нет шаблона содержимого используемых в документации.
5) И давайте уж скажем откровенно часто в комментариях пишут всякий бред не по теме.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.