Welcome to the Single-Page-Book Project
* Consult in a few minutes what previously took hours
* Get a global picture from minute one!
* Zoom into the detail with one click!
The Single-Page-Book format (SPB) try to fix those shortcommings providing the
best of all worlds.
- Mind maps are great at displaying
related topics toghether ("bird's eye view") but they fail to provide concrete information
about the topics themself
- Cheat-sheets are great at providing
daily-usage for a given tool, procedure, task, ... but fail to provide the global mind-map picture
in a bigger context
- Books are great for learning purposes but they are "bloated" with educational content
that is not very useful in repeated reads ("experts consults") and not very conformtable to
work with for daily use, specially when we just want to query some "how-to" time-to-time.
This is worse with electronic book formats like PDFs, WORDs or e-books since moving around is quite
un-confortable on computer screens when compared to printed paper.
To make it possible SPB profits from all the excelent work invested in modern
Web Browsers to provide static and dynamic content:
- A (properly written) single-page-book will offer all the advantages of mind-maps,
cheat-sheats and books.
- SPBs will allow to store as much information as possible no more than one click away
avoiding random searchs in Google/cheat-seats/emails/blogs/crystal balls/...
Single-Page-book pretend to be to documentation what
single-page-apps became for web apps.
- The content "dynamically" allowing to zoom in/out of the content with easy,
(Something like similar to how a user will navigate in Google Maps)
A modern browsers can parse and render tens of megabytes of HTML per second,
and Internet connection is fast enough to play video, so loading page-by-page
does not make sense anymore. The cost of a new page requests is much higher
than the cost of keeping evering in memory. Also offline navigation comes for
Current web sites (and electronic book formats) follow the page-by-page
inherited from printed-paper. Actually being able to zoom in/out "a la Google
Maps provides a much confortable UI in electronic devices. Starting from a zoom-out
and arranging content properly provides a mind-map of the information for free.
In practice a SPB book is just a single web page profiting from a thoroughly
WARN: The CSS It follows the VIM philosophy: "Fast is more important than beauty":
The SPB format can also be used for many other purposes that I did not contemplated
when starting the project.
As an example I'm using a SPB formated page as my browser home-page to store all sort of
"random" info like contacts, bookmarks, projects, work-in-progress, task-lists,
pending payments, home accountancy, travel-management, medical data, project-management,
resource-planning, english and french vocabulary (I'm spanish actually), etc ... and
I'm using just an text-editor (vim, notepad++, ultraedit, ...) to keep the info up-to-date
and accesible with one click
Indirectly SPB promote "best-pattern" approach to documentation by:
- Putting related info close to each other. Actually a single html text file will be used.
- Don't repeat same info twice. This is easier once the previously spread information is located in a single file
- Don't keep notes spread(hidden) amongst hundred of emails
- Don't hide important information inside random menus paths and children pages:
The risk of the Unknown Unknowns can
also be applied to documentation:
People will not search for important information until they are aware that such important information
exists, so better place important information right into the main page.
To create your single-page-book project all that needed is to reuse
and the html template plus some minimum experience with HTML document writing.
Dont' forget to have a look at the demo for a quick look a different possibilities.
What the SPB IS NOT:
Current list of Single Page Books:
- Next follow a list of example single-page-books I've created while working on different topics.
The quality varies from "intention to create something" to "useful for daily work" based on the time
spent and my own experience on each topic.
- alpha or draft state means just the intention to do some work in the future.
- Beta state means that related information is in place, but information is still missing or non-validated.
- Version 1.0 or higher means that content can be used as reference (In my personal experience,
now I have to visit Google much less frequently while programing with Java/Kotlin or
doing linux administrative work)
Pull-request and bug-reporting contributions welcome!