recentpopularlog in

garrettc : documentation   91

« earlier  
Etsy’s experiment with immutable documentation
A super interesting look into how Etsy prevents documentation from going stale by splitting it into “how” docs (prone to change), and “why” docs (less likely to change)
devops  documentation  etsy  slack  programming  bestpractice 
december 2018 by garrettc
Get Started, Part 1: Orientation and setup
Get oriented on some basics of Docker before diving into the walkthrough.
docker  documentation  guide  devops  sysadmin  learning  container 
august 2018 by garrettc
A Human-Readable Interactive Representation of a Code Library
"A how-it-works-style research prototype for understanding a code library."
code  documentation  javascript  programming  visualisation 
july 2018 by garrettc
Introducing Kit
Say hello to Kit, a set of tools for developing, documenting, and testing React components.
javascript  webdevelopment  reactjs  documentation  testing  toolkit 
may 2018 by garrettc
W3C Process for Busy People
"This document aims to provide readers with a shorter overview of the W3C Process Document written in plain English. The original W3C Process Document is a complete document, written to be legally accurate and give indepth detail on each item and process. This document aims to give an overview of the main document, so new and existing W3C participants can gain an understanding of all W3C processes and know where to go for more information."
w3c  standards  process  documentation 
may 2018 by garrettc
12 “Manager READMEs” from Silicon Valley’s Top Tech Companies
"When we launched our first SoapBox hero I was surprised to discover a document used to introduce her working style to her team. I had never seen that before and it was awesome!

Did others have these? I needed to know. Eventually, I found a treasure trove of examples by Engineering Leaders from companies with some of the best culture in tech.

They called them Manager READMEs, or Manager User Manuals. And they’ve graciously let me share them with you."
leadership  management  readme  documentation  transparency  business  mentoring  teams 
may 2018 by garrettc
I feel like an idiot while doing my job.
article  communication  documentation  empathy  simplicity  just 
april 2018 by garrettc
Just Barely Good Enough Models and Documents: An Agile Best Practice
"For some reason people think that JBGE implies that the artifact isn't very good, when in fact nothing could be further from the truth. When you stop and think about it, if an artifact is JBGE then by definition it is at the most effective point that it could possibly be at."
agile  documentation  process  projectmanagement  business 
april 2018 by garrettc
Aides in development across the entire API lifecycle, from design and documentation, to test and deployment.
api  development  documentation  openapi  restful 
december 2017 by garrettc
Ten Extras for Great API Documentation
If you manage to create amazing API documentation and ensure that developers have a positive experience implementing your API, they will sing the praises of your product. Continuously improving your API documentation is an investment, but it can have a huge impact.
api  documentation  webdevelopment  bestpractice 
november 2017 by garrettc
Infusion: An Inclusive Documentation Builder
"Infusion is a high performance generator of rich and accessible documentation sites in the form of progressive web applications (PWAs). That means the documentation sites you create can be saved to your devices and read offline. Because Infusion instances exist as Github repositories, this is possible out of the box. When you commit and push changes to your content, your Github Pages site is updated and a new service worker is installed."
documentation  progressivewebapps  webdevelopment  tool 
september 2017 by garrettc
What nobody tells you about documentation - Blog - Divio
"There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four.

They are: tutorials, how-to guides, discussions and technical reference. They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most software documentation - often immensely."
support  documentation  writing  software 
september 2017 by garrettc
5 Keys to Writing Awesome Documentation
"Poorly written documentation is like food that tastes bad or that’s hard to eat. The sole purpose of documentation is to be read, so it must be well organized and optimized to be easily read and understood."
documentation  business  copywriting  bestpractice 
july 2017 by garrettc
BBC micro:bit MicroPython documentation
A really really good example of well written docs, super friendly and easy to follow.
python  bbc  microbit  board  technology  education  learning  programming  documentation 
july 2017 by garrettc
Guru is a knowledge sharing solution built to enable sales and support teams with the knowledge they need when they need it, without leaving their workflow
documentation  support  tools  business  communication  slack 
june 2017 by garrettc
Design systems, style guides, pattern libraries. What the hell is the difference?
"And this got more complicated when we came with style guides. Or maybe component libraries. Or pattern libraries. Did you hear about design systems? It’s the big thing for 2017. Are they the same? Is there a difference? Why don’t we call it simply documentation?"
designsystems  patternlibrary  styleguide  business  documentation 
june 2017 by garrettc
API Design Guide
"This is a general design guide for networked APIs. It has been used inside Google since 2014 and is the guide we follow when designing Cloud APIs and other Google APIs. It is shared here to inform outside developers and to make it easier for us all to work together."
api  architecture  documentation  google  rest  restful  rpc  network  development 
february 2017 by garrettc
I Don’t Need Help
Just because your users don’t ask for help doesn’t mean they don’t need it.
documentation  webdesign  userexperience  pamoja  help 
february 2017 by garrettc
Design system documentation
"Here is a list of links to all the online design system documentation of note I found while researching how other teams document their design systems, brand guidelines and styleguides."
documentation  styleguide  patternlibrary  designsystems  designthinking  resource 
january 2017 by garrettc
How (and why) to write good documentation
Patience and empathy are the basis of good documentation, much as they are the basis for being a decent person. Here's a how-to for creating better open source project docs, which can help your users and grow your community.
documentation  opensource  writing 
january 2017 by garrettc
8 hints for keeping your project well documented
"During every project a lot of knowledge is “stored” in team members brains. Unfortunately, human memory is not the safest place to keep valuable information and that’s why you have to secure the project knowledge “on paper” (of course you will use computer for that). In this article I’ll try to give some hints that I’ve found reasonable for the 3 most common types of documents."
documentation  webdevelopment  appdevelopment  bestpractice 
january 2017 by garrettc
PagerDuty Incident Response Documentation
A collection of information about the PagerDuty incident response process. Not only how to prepare new employees for on-call responsibilities, but also how to handle major incidents, both in preparation and after-work.
documentation  devops  example  sysadmin  oncall 
january 2017 by garrettc
18F Slack Handbook
A great internal document from the US Government digital team about how to use Slack.
slack  documentation  government  bestpractice 
november 2016 by garrettc
Design System Doc Components
Excellent tips and advice for documenting a design system.
designsystems  designthinking  webdesign  design  documentation 
september 2016 by garrettc
Five tips for improving your technical writing and documentation.
Get more users and fewer support requests by leveling up your writing and technical documentation.
documentation  writing  readme 
september 2016 by garrettc
TLDR pages
Simplified and community-driven man pages
unix  linux  documentation  nodejs  npm 
december 2015 by garrettc
Static site generator to build project documentation with Markdown.
documentation  html  markdown  python 
september 2015 by garrettc
How to Produce a High Quality Screencast
Tutorial on how to produce a high quality screencasts
video  business  education  screencast  documentation 
july 2015 by garrettc
Building a Self-Documenting REST API
"…any API is only as good as its documentation. Wouldn't it be great if Drupal could build out this documentation for us – and keep it current as we make changes?"
drupal  drupal8  rest  restful  headless  api  documentation  webdevelopment 
june 2015 by garrettc
RESTful API Modeling Language
"RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based emergence of best practices."
api  documentation  rest  tools  restful  http 
may 2015 by garrettc
KSS Knyle Style Sheets
"Documentation for any flavor of CSS that you’ll love to write. Human readable, machine parsable, and easy to remember."
css  documentation  styleguide  less  sass 
february 2015 by garrettc
Drupal 8 Modules
"This article will be more about the patterns you need to use during Drupal 8 development than how to fit the various pieces together."
documentation  drupal  drupal8  webdevelopment  development  php  patterns  learning 
november 2014 by garrettc
A superset of markdown to write books and documentation
markdown  authoring  writing  documentation  books 
october 2014 by garrettc
Whitehall publisher content types: best practice examples
Examples of content formats published on GOV.UK, including guidance, detailed guides and news stories.
contentstrategy  documentation  contenttypes  gds 
october 2014 by garrettc
combines 43 reference documentations in a fast, organized, and searchable interface: HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C, C++, etc.
javascript  python  css  documentation  html  jquery  reference  php  ruby 
september 2014 by garrettc
Ops School Curriculum — Ops School Curriculum 0.1 documentation
Ops School is a comprehensive program that will help you learn to be an operations engineer.
sysadmin  devops  linux  windows  unix  documentation  operations 
june 2014 by garrettc
As devs we struggled with handing over website manuals.
worldwideweb  web  webdevelopment  documentation  tools 
march 2014 by garrettc
Using the Console
Useful documentation for the Chrome console.
documentation  javascript  reference  browser  chrome 
november 2013 by garrettc
Medium - Terms of Service
Very well written and clear terms of service for Medium. They even manage to handle the dreaded lawyerese with some grace.
business  law  legal  documentation  wdcs  wdcsintranet  copywriting 
august 2012 by garrettc
Little Printer style guide
The Little Printer style guide and API documentation is delightful. (PDF link)
littleprinter  styleguide  api  documentation  berg 
august 2012 by garrettc
Democratized Science Instrumentation
Ariel Waldman recently wrote/curated a guidebook on democratized science instrumentation, documenting both hardware and software that significantly increase people’s opportunity to participate in scientific discovery.
science  hardware  software  documentation  society 
may 2012 by garrettc
Python based documentation tool.
documentation  python  tools 
may 2012 by garrettc style guide
Very good example of a web style guide from
css  webdesign  documentation  styleguide 
december 2011 by garrettc
cxpartners UX Resources
Amazing collection of UX templates from CXPartners and their new book "Communicating the user experience".
omnigraffle  userexperience  wireframes  documentation  diagram  resource 
december 2011 by garrettc
Tangle: a JavaScript library for reactive documents
JavaScript library for creating reactive documents. Play with parameters, and see the document update immediately.
javascript  library  documentation  wdcs  science  analysis  webdevelopment 
october 2011 by garrettc
jQuery 1.5.1 Offline Learning Kit
Including printable reference sheets and the 1.5.1 documentation in an offline format
jquery  javascript  tutorial  learning  reference  guide  documentation 
march 2011 by garrettc
Writing great documentation
"Tech docs can take a bunch of different forms ranging from high-level overviews, to step-by-step walkthroughs, to auto-generated API documentation. Unfortunately, no single format works for all users; there’s huge differences in the way that people learn, so a well-documented project needs to provide many different forms of documentation."
documentation  writing  howto  tutorial  tips 
july 2010 by garrettc
I still have a fondness for Emacs, so sue me. It's the *nix editor I cut my teeth on back in the day and this looks like a fantastic resource.
emacs  wiki  reference  editor  documentation  software 
july 2010 by garrettc
Git Reference
A quick reference for learning and remembering the most important and commonly used Git commands.
git  reference  documentation  development  dvcs 
june 2010 by garrettc
Welcome to @Anywhere
Twitter's new API/Application framework/Thingy.
twitter  api  javascript  jquery  webdevelopment  documentation 
april 2010 by garrettc
Using Wikis to Document UI Specifications
How your design team can benefit from wiki collaboration while avoiding its pitfalls
documentation  collaboration  agile  projectmanagement  wiki 
july 2009 by garrettc
Guide to javascript in Drupal
Introductory documentation on how to write Javascript/jQuery code for Drupal.
javascript  jquery  webdevelopment  guide  drupal  api  documentation  torchbox 
january 2009 by garrettc
REST Anti-Patterns
"...typical examples of attempted RESTful HTTP usage that create problems and show that someone has attempted, but failed, to adopt REST ideas."
architecture  development  documentation  howto  http  information  interface  programming  reference  rest  url  webservices  patterns  tips  restful 
july 2008 by garrettc
Module-In-A-Box: We Built Admin Tools So You Don't Have To
Scaffolding module for Drupal that takes a lot of the headache out of building modules that require data storage
database  development  documentation  drupal  useful  module 
june 2008 by garrettc
Google Doctype
Google launches a reference library for web developers
code  css  documentation  dom  google  howto  html  javascript  programming  reference  resource  useful  webdevelopment 
may 2008 by garrettc
Doodles, Drafts & Designs: Industrial Drawings from the Smithsonian
Fascinating collection of industrial design documentation by engineers, inventors, and designers.
art  design  diagram  documentation  drawing  gallery  history  illustration  inspiration  resource  technology  museum  smithsonian 
february 2008 by garrettc
« earlier      
per page:    204080120160

Copy this bookmark:

to read