|||

knowledge management

All sections →
 → Note titles as API calls Oct 30, 2020 highlights & knowledge management

i saw someone say that note titles should be like API names (from @davestridsr on the Obsidian Discord)

It was Andy Matuschak: https://notes.andymatuschak.org/Evergreen_note_titles_are_like_APIs

An app adds an API when its developers want other developers to be able to extend and work with the app’s functions, e.g., to develop other features or to let services interact with one another.

Some “good” features of an API in software development might be that the API is: (1) deep (you can get at as many functions of the underlying app as are useful), (2) expressive (you can fine-tune interactions between your extension and the app), and (3) intuitive (by looking at an API function’s title and parameters, it’s pretty easy to guess what it allows you to do).

Andy’s saying that a good note title fits those parameters too. The metaphor goes: you “extend” an atomic evergreen note by invoking its title in a new note. By doing so (and if done right), you can grasp the details of that note easily while, at the same time, you can reinterpret it in its new context.