github

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

docs

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

git

Back to Top ↑

documentation

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Back to Top ↑

repos

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

case study

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

use case

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

collaboration

Back to Top ↑

tools

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Back to Top ↑

wireframes

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

developer documentation

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Back to Top ↑

developers

Back to Top ↑

writers

Back to Top ↑

testing

Back to Top ↑

balsamiq

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

static sites

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

hugo

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

gif

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

animated gifs

Multiple product versions - Balsamiq, Leon Barnard

Learn useful techniques for static sites such as Hugo on GitHub from Leon Barnard, Designer and Writer at Balsamiq. He describes documenting multiple versions of a product with a Go coded solution.

Back to Top ↑

editorial workflow

Back to Top ↑

developer

Back to Top ↑

improvement

Back to Top ↑

quality

Back to Top ↑

gitbook

Back to Top ↑

book

Back to Top ↑

workflows

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

swagger

Back to Top ↑

openapi

Back to Top ↑

api

Back to Top ↑

API documentation

Back to Top ↑

open source

Back to Top ↑

transformation

Back to Top ↑

cicd

Back to Top ↑

UX

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Back to Top ↑

community

Back to Top ↑

style guide

Back to Top ↑

templates

Back to Top ↑

backstage

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑

spotify

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑

definitions

Back to Top ↑

repository

Back to Top ↑

branch

Back to Top ↑

fork

Back to Top ↑

pull request

Back to Top ↑

issues

Back to Top ↑

bugs

Back to Top ↑

technical debt

Back to Top ↑

backlog

Back to Top ↑

ebook

Back to Top ↑

epub

Back to Top ↑

web

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

content

Case Study - Pantheon, Rachel Whitton

In this use case, the Technical Content Editor at Pantheon, Rachel Whitton, describes their use of GitHub for documentation on a platform for WordPress and Drupal.

Back to Top ↑

javadoc

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Back to Top ↑

doxygen

Case Study - Symantec, Jennifer Rondeau

Jennifer Rondeau, Technical Writing Manager at Capital One, talks about her experiences as a Principal Information Developer at Symantec integrating code and documentation tightly.

Back to Top ↑

dapperdox

Back to Top ↑

API docs

Back to Top ↑

API documentation generators

Back to Top ↑

wiki

Back to Top ↑

rest api

Back to Top ↑

standards

Back to Top ↑

raml

Back to Top ↑

stripe

Back to Top ↑

rackspace

Back to Top ↑

support

Back to Top ↑

writethedocs

Back to Top ↑

video

Back to Top ↑

conferences

Back to Top ↑

engineering

Back to Top ↑

security

Back to Top ↑

jekyll

Back to Top ↑

static site

Back to Top ↑

change

Back to Top ↑

culture

Back to Top ↑

teamwork

Back to Top ↑

development

Back to Top ↑

publishing

Back to Top ↑

lulu

Back to Top ↑

self-publishing

Back to Top ↑

design

Back to Top ↑

layout

Back to Top ↑

circleci

Back to Top ↑

cloudify

Back to Top ↑

Docker

Back to Top ↑

Hugo

Back to Top ↑

Go

Back to Top ↑

Design Thinking

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Back to Top ↑

Information Architecture

Building Our Documentation Site on platformOS — Part 1: Information Architecture

This article series describes our process for building the platformOS documentation site, with in-depth insights into our approach, decisions, and plans. In this part, we share how we started, how we got to know our audience, how we figured out what content we need, and how we outlined a sitemap for our documentation site.

Back to Top ↑

Content-First Design

Back to Top ↑

contributor experience

Back to Top ↑

python

Back to Top ↑

sphinx

Back to Top ↑

contribution

Back to Top ↑

QA

Back to Top ↑

performance

Back to Top ↑

portal

Back to Top ↑

internal

Back to Top ↑

learning

Back to Top ↑

teaching

Back to Top ↑

docs-like-code

Back to Top ↑

onboarding

Back to Top ↑

TechDocs

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑

roadie

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑

mkdocs

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑

service catalog

Setting up Techdocs on Backstage

Techdocs is Spotify’s homegrown docs like code solution. it allows the user to store documentation to near code thus allowing it to be easily discovered.

Back to Top ↑