Requirements for s Zettelkasten System

tomp

Before I got into real development of my Zettelkasten system, I wrote a set of user requirements. I just came across them and thought they might be of interest. The current system meets the requirements closely, with an exception that backlinks are optional, not automatic. References to "Leo" mean the Leo-editor, which is a MORE-influenced outliner implemented in Python.

Zettelkasten Requirements

Basic User Requirements
=======================

    1. No Lockin
    ============

    **Requirement**: The notes data must be in such a form that they may be transferred to another notes system (even a paper one) without losing any essential data.

    **Discussion**: If the note-keeper decides to change to another notes mangement system, the data must be useful outside the Zettel-box, so that months or years of research not be lost.  What is the most basic alternative system?  That would probably be a full-text search system.  Another basic system would be a paper system like the original zettelkasten.

    These needs lead to the next requirement.

    2. Text Files
    =============

    **Requirement**: The zettel-box notes must be in a text format.  They may be one note per file, all notes in one file, or a combination. Alternatively, the system must be able to export such files with no loss of data.

    **Definition**: "Text format" includes slightly structured text-based formats like Markdown or ReStructured Text.  It excludes more complex formats such as XML.  The intent is that the note files must be easily readable by a person.

    **Discussion**: Using one file per note seems to be the simplest way to emulate the original paper-based system, which had one card per note.  However, a larger file could be used if there is simple way to extract or recognize individual notes.  This would allow a computer program to separate the individual note if needed.


    3. Simple Section Demarkations
    ==============================

    **Requirement**: If a note needs identified sections, the section demarkations must be easy to type, easy to read, and easy to parse by computer.

    **Discussion**: An identified section could be a URL, a group of references to other notes, a tag or indexing aid, a citation list, etc.

    4. Unique Identification
    ========================

    **Requirement**: Each note must be uniquely identifiable, so that it can be referenced by other notes.

    5. Hierarchical Navigation
    ==========================

    **Requirements**: The system must support a flexible system for identifying notes that have parent/child or sibling relationships with other notes.  These relationships must be included in the text files or the exported data.  It must be possible to also have notes that do not possess a hierarchical designation (possibly as a temporary characteristic).

    **Ref**: see `The Zettelkasten Method <https://www.lesswrong.com/posts/NfdHG6oHBJ8Qxc26s/the-zettelkasten-method-1#Card_Layout>`_.

    **Discussion**: This was a key characteristic of the original Zettelkasten system.  Basically it amounted to each note having an optional parent-child  or sibling relationship with certain related notes.  In the paper system, a note was decorated with an indexing expression like "1.2.1.4" or (a more concise form) "1a1d".  This designation let the notekeeper file and find closely related note cards.

    The system needs to be flexible because it is likely that newer notes will be created to elaborate on older ones, so insertions will be required.  In the original system, these designations acted as unique card identifiers.

    **Note**: All notes must be findable whether or not they contain any links to any other parent/child or sibling notes.

    6. Link Navigation
    ==================

    **Requirement**: It must be possible to link a note to other notes by reference.

    **Discussion**: This implies that each note must have a unique identifier that does not change.  This was another essential property of the original paper-based zettelkasten system.  It is this linking that seems to have promoted the system's legendary reputation for enhancing creativity.

    In the original paper system, the indexing expression served as the identifier.

    7. Time Stamp
    =============

    **Requirement**: Each note must be able to have an optional timestamp.

    **Discussion**: A number of people have written that having a timestamp is helpful in reconstructing the context of recent work, since the most recent notes most likely represent work that was recently done.

    It is currently unclear about whether only a creation date would be enough, or whether a last-modified date will also be helpful.  It the interest of simplicity in a potential move to hand-created or paper notes, a single date would be better.

    8. Tags
    =======

    **Requirement**: The system must be capable of optionally attaching one or more "tags" to any note.  Tags must be easy to create, delete, and attach.

    **Definition**: A tag means a property represented by a name (a string).

    **Discussion**: Tags serve primarily as a filtering mechanism, to help identify notes in a general area of interest.

    9. Backlinks
    ============

    **Requirement**: For every link to another note that is inserted into a note, the system must create a corresponding link in the target back to the first note.  Alternatively, the linking system may be inherently bi-directional, such that backlinks occur automatically.

    **Discussion**: If the system exports data to text files, the backlinks must be included in the exported notes data.

    10. Display Styles
    ==================

    **Requirement**: Selected subsets of notes must be displayable in both a hierarchical display (where parent/child or sibling relationships exist) and a non-hierarchical display of associated notes.

    **Discussion**: A strength of the original zettelkasten paper system was that one was not forced into thinking about the notes as having any kind of a strict hierarchy.  This feature must be preserved in the new system.  The apparently hierarchical identity coding was mainly for locating notes in the note boxes.  However, notes near each other were more likely to relate to each other.

    It would be possible to have parent/child relationship between notes that were not located near each other, but having them close together tends to make them more available when working on a subset of notes.

    **Requirement**: It must be possible to add additional types of displays besides a basic parent/child.style.

    **Discussion**: This should not be taken to imply that any arbitrary display idea should be easy or even feasible to implement.  It is intended to indicate that other display styles than a straight parent/child hierarchical display will probably be found to be desirable, and that the system should make it possible to implement at least some kinds.

        *Display Styles*
        ================
        In Leo, the most obvious way to display subsets of notes would be to clone them and move the clones under a single organizing node.  This collection could be ephemeral or permanent as the user desires.  

        For a non-hierarchical display, the simplest  way would be to have all the notes (or their clones) as siblings under a single organizing node.

        LeoVue is one system that makes possible coordination with browser-based displays, some of which can be be interactive so that actions in the browser can be reflected back to the Leo file.  There are probably other such systems.

        This is one way in which new display kinds could be created, ones that Leo's panes and display mechanisms may be less suited for.  The cost, aside from the effort of implementation, would be that a web server would have to be involved, most likely on the user's computer.  However, such relatively simple personal servers are not hard to install and get working.

    11. Citations
    =============
    **Requirement**: It must be possible to maintain a collection of citations to source material.  It must be possible for a zettel-box note to reference any of these citations.  It must be possible to retrieve the text of the citation when desired.

    **Definition**: "Citation" means a standardized means of reference to a specific source material.

    **Discussion**: An academic citation includes title and and publication data in a standardized form. This is the main kind of citation envisioned here.  Possibly, a citation could also be a URL to an on-line resource.