Add section on developer documentation into best practices docs (#95473) (#95487)

* add section on dev docs to best pratices.

* Update best_practices.mdx

* Update dev_docs/best_practices.mdx

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

dev_docs/best_practices.mdx

@@ -12,6 +12,132 @@ tags: ['kibana', 'onboarding', 'dev', 'architecture']
 First things first, be sure to review our <DocLink id="kibDevPrinciples" text="development principles"/> and check out all the available
 platform <DocLink id="kibBuildingBlocks" text="building blocks"/> that can simplify plugin development.
 
+## Developer documentation
+
+### High-level documentation
+
+#### Structure
+
+Refer to [divio documentation](https://documentation.divio.com/) for guidance on where and how to structure our high-level documentation.
+
+<DocLink id="kibDevDocsWelcome" text="Getting started" /> and
+<DocLink id="kibPlatformIntro" text="Key concepts" /> sections are both _explanation_ oriented,
+<DocLink id="kibDevTutorialBuildAPlugin" text="Tutorials" /> covers both _tutorials_ and _How to_, and
+the <DocLink id="kibDevDocsApiWelcome" text="API documentation" /> section covers _reference_ material.
+
+#### Location
+
+If the information spans multiple plugins, consider adding it to the [dev_docs](https://github.com/elastic/kibana/tree/master/dev_docs) folder. If it is plugin specific, consider adding it inside the plugin folder. Write it in an mdx file if you would like it to show up in our new (beta) documentation system.
+
+<DocCallOut title="internal only">
+
+To add docs into the new docs system, create an `.mdx` file that
+contains <DocLink id="docsSyntax" section="frontmatter" text="frontmatter"/>. Read about the syntax <DocLink id="docsSyntax" text="here"/>. An extra step is needed to add a menu item. <DocLink id="docsSetup" text="These instructions" /> will walk you through how to set the docs system
+up locally and edit the nav menu.
+
+</DocCallOut>
+
+#### Keep content fresh
+
+A fresh pair of eyes are invaluable. Recruit new hires to read, review and update documentation. Leads should also periodically review documentation to ensure it stays up to date. File issues any time you notice documentation is outdated.
+
+#### Consider your target audience
+
+Documentation in the Kibana Developer Guide is targeted towards developers building Kibana plugins. Keep implementation details about internal plugin code out of these docs.
+
+#### High to low level
+
+When a developer first lands in our docs, think about their journey. Introduce basic concepts before diving into details. The left navigation should be set up so documents on top are higher level than documents near the bottom.
+
+#### Think outside-in
+
+It's easy to forget what it felt like to first write code in Kibana, but do your best to frame these docs "outside-in". Don't use esoteric, internal language unless a definition is documented and linked. The fresh eyes of a new hire can be a great asset.
+
+### API documentation
+
+We automatically generate <DocLink id="kibDevDocsApiWelcome" text="API documentation"/>. The following guidelines will help ensure your <DocLink id="kibPlatformIntro" section="public-plugin-api" text="public APIs" /> are useful.
+
+#### Code comments
+
+Every publicly exposed function, class, interface, type, parameter and property should have a comment using JSDoc style comments.
+
+- Use `@param` tags for every function parameter.
+- Use `@returns` tags for return types.
+- Use `@throws` when appropriate.
+- Use `@beta` or `@deprecated` when appropriate.
+- Use `@internal` to indicate this API item is intended for internal use only, which will also remove it from the docs.
+
+#### Interfaces vs inlined types
+
+Prefer types and interfaces over complex inline objects. For example, prefer:
+
+```ts
+/**
+* The SearchSpec interface contains settings for creating a new SearchService, like
+* username and password.
+*/
+export interface SearchSpec {
+ /**
+  * Stores the username. Duh,
+  */
+ username: string;
+ /**
+  * Stores the password. I hope it's encrypted!
+  */
+ password: string;
+}
+
+ /**
+  * Retrieve search services
+  * @param searchSpec Configuration information for initializing the search service.
+  * @returns the id of the search service
+  */
+export getSearchService: (searchSpec: SearchSpec) => string;
+```
+
+over:
+
+```ts
+/**
+  * Retrieve search services
+  * @param searchSpec Configuration information for initializing the search service.
+  * @returns the id of the search service
+  */
+export getSearchService: (searchSpec: { username: string; password: string }) => string;
+```
+
+In the former, there will be a link to the `SearchSpec` interface with documentation for the `username` and `password` properties. In the latter the object will render inline, without comments:
+
+![prefer interfaces documentation](./assets/dev_docs_nested_object.png)
+
+#### Export every type used in a public API
+
+When a publicly exported API items references a private type, this results in a broken link in our docs system. The private type is, by proxy, part of your public API, and as such, should be exported.
+
+Do:
+
+```ts
+export interface AnInterface { bar: string };
+export type foo: string | AnInterface;
+```
+
+Don't:
+
+```ts
+interface AnInterface { bar: string };
+export type foo: string | AnInterface;
+```
+
+#### Avoid “Pick”
+
+`Pick` not only ends up being unhelpful in our documentation system, but it's also of limited help in your IDE. For that reason, avoid `Pick` and other similarly complex types on your public API items. Using these semantics internally is fine.
+
+![pick api documentation](./assets/api_doc_pick.png)
+
+### Example plugins
+
+Running Kibana with `yarn start --run-examples` will include all [example plugins](https://github.com/elastic/kibana/tree/master/examples). These are tested examples of platform services in use. We strongly encourage anyone providing a platform level service or <DocLink id="kibBuildingBlocks" text="building block"/> to include a tutorial that links to a tested example plugin. This is better than relying on copied code snippets, which can quickly get out of date.
+
 ## Performance
 
 Build with scalability in mind.