otto-de / otto-de/api-guidelines

[update] Write introduction into API lifecycle

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
50
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Context

While discussing the compatibility chapter refactoring the idea came up to include a brief introduction to the API lifecycle as part of the Core principles in the API Guidelines.

To do

  • Clarify the wording "shutdown" and "removal".
  • Suggest new section "API lifecycle" as a pull request based on the drafts attached to this issue in the comments.
  • Have pull request reviewed by a Technical Writer and an API coach.

Deliverables

New section "API lifecycle" available in the API Guidelines.

Further information

Topics, that should be explained with possible references to compatibility chapters (for REST and Events) for further detailing information about how to do it:

  1. Introduction of new APIs
  2. Compatible extensions of APIs
  3. Incompatible extensions of APIs
  4. End of life of APIs

Original: slinstaedt
opened [on Mar 3, 2022]

Internal issue: https://github.com/otto-ec/techwriting_hub/issues/16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the API Guidelines' Core principles and the linked REST and Events compatibility chapters. Review the drafts referenced in the issue comments, if available, and clarify the terms “shutdown” and “removal.” Done means a reviewed “API lifecycle” section covering API introduction, compatible and incompatible extensions, and end of life.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.