Skip Navigation
Show nav
Heroku Dev Center
  • Get Started
  • Documentation
  • Changelog
  • Search
  • Get Started
    • Node.js
    • Ruby on Rails
    • Ruby
    • Python
    • Java
    • PHP
    • Go
    • Scala
    • Clojure
  • Documentation
  • Changelog
  • More
    Additional Resources
    • Home
    • Elements
    • Products
    • Pricing
    • Careers
    • Help
    • Status
    • Events
    • Podcasts
    • Compliance Center
    Heroku Blog

    Heroku Blog

    Find out what's new with Heroku on our blog.

    Visit Blog
  • Log inorSign up
View categories

Categories

  • Heroku Architecture
    • Dynos (app containers)
    • Stacks (operating system images)
    • Networking & DNS
    • Platform Policies
    • Platform Principles
  • Command Line
  • Deployment
    • Deploying with Git
    • Deploying with Docker
    • Deployment Integrations
  • Continuous Delivery
    • Continuous Integration
  • Language Support
    • Node.js
    • Ruby
      • Working with Bundler
      • Rails Support
    • Python
      • Background Jobs in Python
      • Working with Django
    • Java
      • Working with Maven
      • Java Database Operations
      • Working with the Play Framework
      • Working with Spring Boot
      • Java Advanced Topics
    • PHP
    • Go
      • Go Dependency Management
    • Scala
    • Clojure
  • Databases & Data Management
    • Heroku Postgres
      • Postgres Basics
      • Postgres Getting Started
      • Postgres Performance
      • Postgres Data Transfer & Preservation
      • Postgres Availability
      • Postgres Special Topics
    • Heroku Data For Redis
    • Apache Kafka on Heroku
    • Other Data Stores
  • Monitoring & Metrics
    • Logging
  • App Performance
  • Add-ons
    • All Add-ons
  • Collaboration
  • Security
    • App Security
    • Identities & Authentication
    • Compliance
  • Heroku Enterprise
    • Private Spaces
      • Infrastructure Networking
    • Enterprise Accounts
    • Enterprise Teams
    • Heroku Connect (Salesforce sync)
      • Heroku Connect Administration
      • Heroku Connect Reference
      • Heroku Connect Troubleshooting
    • Single Sign-on (SSO)
  • Patterns & Best Practices
  • Extending Heroku
    • Platform API
    • App Webhooks
    • Heroku Labs
    • Building Add-ons
      • Add-on Development Tasks
      • Add-on APIs
      • Add-on Guidelines & Requirements
    • Building CLI Plugins
    • Developing Buildpacks
    • Dev Center
  • Accounts & Billing
  • Troubleshooting & Support
  • Integrating with Salesforce
  • Extending Heroku
  • Dev Center
  • Writing a Dev Center Article

Writing a Dev Center Article

English — 日本語に切り替える

Last updated February 15, 2022

Table of Contents

  • Step 1: Choose the Article’s Goal
  • Step 2: Search for Related Articles
  • Step 3: Create an Outline
  • Step 4: Create a Draft Article
  • Step 5: Check Content for Accuracy
  • Step 6: Get Your Article Edited and Published

Heroku team members and add-on providers write and maintain Dev Center articles. This guide describes the writing process for Heroku Dev Center articles at a high level.

Non-Dev Center contributors can use this article as a reference for establishing conventions for their own documentation projects.

Step 1: Choose the Article’s Goal

Create content for an actual use case. Ensure your article has a clear goal.

Consider who your audience is, their situation and motivation, and the expected outcome. It can be helpful to express this goal in a sentence. For example, the goal of Connecting to a Private or Shield Heroku Postgres Database from an External Resource is:

As a developer, I want to connect to Heroku Postgres externally so that my non-Heroku apps can use the data.

Step 2: Search for Related Articles

Search the Dev Center for articles related to your topic. This search can help narrow down the scope of what to include, as well as indicate content gaps to fill with your article.

Step 3: Create an Outline

Many writers find it helpful to create an outline before writing their drafts. You can structure your article with major headings and bullet point notes to get started.

Step 4: Create a Draft Article

Follow these writing guidelines to ensure a consistent reading experience for users:

  • Dev Center Voice and Tone Guidelines
  • Dev Center Content Guidelines
  • Dev Center Style Guidelines

Step 5: Check Content for Accuracy

Get subject matter experts to review and approve your content for accuracy.

Verify Instruction Steps and Examples

You’re responsible for performing all steps to ensure accuracy. Whenever possible, use a fresh development environment to do so.

Step 6: Get Your Article Edited and Published

Heroku team members can notify the Dev Center team to review their article. This editorial review is the last step before publishing. Ensure that a subject matter expert approved the article before this final review. Dev Center editors make any necessary edits to conform to writing guidelines before publishing.

Add-on providers can follow the submission process in the Add-on Partner Portal to get their work edited, approved, and published.

Keep reading

  • Dev Center

Feedback

Log in to submit feedback.

Information & Support

  • Getting Started
  • Documentation
  • Changelog
  • Compliance Center
  • Training & Education
  • Blog
  • Podcasts
  • Support Channels
  • Status

Language Reference

  • Node.js
  • Ruby
  • Java
  • PHP
  • Python
  • Go
  • Scala
  • Clojure

Other Resources

  • Careers
  • Elements
  • Products
  • Pricing

Subscribe to our monthly newsletter

Your email address:

  • RSS
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku Blog
    • Heroku News Blog
    • Heroku Engineering Blog
  • Heroku Podcasts
  • Twitter
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku
    • Heroku Status
  • Facebook
  • Instagram
  • Github
  • LinkedIn
  • YouTube
Heroku is acompany

 © Salesforce.com

  • heroku.com
  • Terms of Service
  • Privacy
  • Cookies
  • Cookie Preferences