Skip to content

Improve all README and other content on public repos to better guide users #924

@tillig

Description

@tillig

Context

As a Fiserv developer, I'm interested in having as much context as possible to understand how to work with Developer Studio content. The standard mechanism for providing this context in Git-based projects is to include rich README.md content as well as standard files like CONTRIBUTING.md and so on.

Currently all standard README content is very light or non-existent. For example:

The README in this Support repo doesn't actually explain that it's support for Developer Studio. It assumes one might have come from Developer Studio to start (a bad assumption) and even has a weird "test" typo at the end of the document

Support README

The README in the "remote-actions" repo, where I should be able to get information on how to use the actions, etc., is entirely empty with just a header.

remote-actions README

Solution

All repositories should include robust and well-written README information that provides...

  • An overview of what's in the repository and how to use it.
  • Links to additional docs in the repo or relevant locations.
  • If needed (like in "remote-actions"), things like troubleshooting information or other helpful guidance.

All documentation should be written in a professional manner and proofread for correctness, as with any public, customer-facing documentation. No typos, weird capitalizations, non-standard acronyms, etc.

Alternatives

There really isn't an alternative to proper documentation.

Additional Context

No response

Region

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions