recentpopularlog in

tobym : documentation   44

A simple, Git-powered wiki with a sweet API and local frontend.
This is what github uses. There are plugins for PlantUML, among others. Understands syntax highlighting.
generator  wiki  static  documentation 
10 weeks ago by tobym
Introduction to text manipulation on UNIX-based systems
Great docs on nix commands like head/tail, comm/diff, cut/split, join, and plenty of others.
text  unix  cli  linux  sysadmin  documentation  reference 
february 2019 by tobym
Alexandrian Form (of documention)
The AlexandrianForm of patterns has the following sections:

Title
The name of the pattern. Alexander's names can name the thing created by the pattern, the process of creating it, or some attribute of the solution.
Prologue
One sentence per pattern that can be expected to precede this one.
Problem statement
One or two sentences that summarize the problem solved by the pattern.
Discussion
Anywhere from 4 to 40 paragraphs that illuminate the system of forces resolved by the pattern.
Solution
One or two sentences that tell you what to do to solve the problem.
Diagram
A picture or two, hand sketched or photographed, that illustrate the pattern (and sometimes the lack of the pattern).
Epilogue
One sentence per pattern that can be expected to follow this one.
documentation  howto  patterns  architecture  advice 
october 2018 by tobym
Generating documentation as code with mermaid and PlantUML » Gofore
Proposal: keep your architecture diagrams and such as plaintext (mermaid or plantuml), render as PNG or whatever using corresponding tool.
documentation  diagrams 
july 2018 by tobym
Documenting your architecture: Wireshark, PlantUML and a REPL to glue them all.
Clojure program to turn wireshark json traces into plantuml sequence diagram format!
networking  documentation  devops  architecture  clojure  wireshark 
september 2017 by tobym
lord/slate: Beautiful static documentation for your API
Slate helps you create beautiful, intelligent, responsive API documentation.
documentation  generator 
august 2017 by tobym
csvkit documentation
csvkit is a suite of command-line tools for converting to and working with CSV, the king of tabular file formats.
csv  data  analysis  datamining  cli  python  documentation  reference 
april 2017 by tobym
PagerDuty Incident Response Documentation
Process for on-call people handling incidents: before, during, post-mortems, etc.
devops  documentation  on-call 
january 2017 by tobym
Overview — Sphinx 1.4.5 documentation
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
python  documentation  tools 
july 2016 by tobym
Oozie - Java API example
Minimal example of using Oozie's Java API to run a workflow.
oozie  hadoop  example  documentation 
march 2016 by tobym
jsdoc3/jsdoc
Doc generator for JavaScript
docs  jsdoc  javascript  documentation 
august 2012 by tobym
Home | Read the Docs
Read the Docs hosts documentation, making it fully searchable and easy to find.
docs  documentation 
august 2012 by tobym
Common Lisp HyperSpec (TM)
common lisp reference. (sbcl refers to this)
lisp  reference  documentation 
april 2012 by tobym
docco.coffee
tool for "literate programming" documentation generator. this one (original) is in node.js but there are ports also for sh, ruby, python, etc
documentation 
august 2011 by tobym

Copy this bookmark:





to read