ABCDEFGHIJKLMNOPQRS
1
TimestampWhat is your gender identification?Which of the following areas best describes your current position?What is your familiarity with Event-Driven Architectures on a scale of 1 to 5, where 1 represents "Not at all familiar" and 5 represents "Very familiar"?What is your experience with APIs on a scale of 1 to 5 where 1 represents "Little to no experience" and 5 represents "Expert"Are you and/or is your team currently using Event-Driven Architecture (EDA) in your workflow?If you DO use Event-Driven Architecture (EDA) in your workflow, how do you currently document your Event-Driven Architecture? What are the challenges that you face while doing so? What are some things that you do to overcome these challenges?If you DO use Event-Driven Architecture (EDA) in your workflow, what tools/processes are you and/or is your team currently using to know which events are available to you as a developer?If you DO NOT use Event-Driven Architecture (EDA) in your workflow but you use APIs in your workflow, what is your experience with documenting or consuming an API? What challenges do you face, and how do they make you feel?What challenges do you face when using an Event-Driven Architecture's documentation AND/OR an APIs documentation to build an application integration? Are there any ways in which you feel these challenges could be resolved?
2
5/24/2022 9:36:48MaleSystem Architect33YesAsyncApiAsyncApiTooling around writing verbose api domentation
3
5/26/2022 5:47:25MaleSoftware Architect44Yeswiki pages; keeping documentation up to date, making examples available.. insights in consumers and which version is being used.Basically missing a good registry and portalGit, Wiki, email, Console of brokersDifficult to get tracktion in usage of a portal for internal APIs. Convincing developers and POs, information analysts that properly documenting a schema pays off big time.Integration with message brokers and development environment of APIs. Lack of support for newer specification languages and json schema versions.
4
6/2/2022 8:38:24MaleDevRel44YesNotion & whimsical Formatting / ease of keeping up to date and not creating a graveyard of information. Trouble making sure data structure dependencies obvious to stakeholdersLack of detail in a lot of docs - not enough examples in many docs
5
6/5/2022 2:47:37FemaleTechnical Writer11NoUma RajamaniUma RajamaniUma RajamaniUma Rajamani
6
6/6/2022 5:44:04MaleSoftware Architect54YesI include details in service contract document such as protocol, input, output, exceptions, security details. It is a manual process to maintain changes, it can not be discoverable and searchable.Confluence API registry helps for sync APIs by exposing RAMLs. Challenges in maintaining production Vs in progress APIs in registry. Having single registry for Async and Sync APIs can resolve many issues. Also a way to automatically getting update API details to registry after deploying in containers/servers. Also a way to allow teams/persons to provide authorisation to access APIs.
7
6/6/2022 6:18:34MaleAPI Architect55YesAsyncAPI schémas and APIOpsMissing of tooling and end to end API lifecycle
8
6/6/2022 9:50:27MaleSoftware Architect45YesEvent catalogue, openapiSwaggerIntegeation with different services like azurebrokers ans aws brokers
9
6/6/2022 11:08:57MaleSoftware Engineering34Yesgetting overwhelmed with the resource to refer from
10
6/6/2022 13:47:55MaleSoftware Architect45YesCurrently diagrams (IcePanel), Git wiki and Google Docs. Looking for better solutionsAWS EventBridgeUsing OpenAPI and AWS Gateway but would like to have a universal REST and Event based We have fat data that will not fit into Events themselves. So we're passing links to s3 objects in the Events. We still want to integrate the API definitions with both the Event schema and the "fat data" schemas
11
6/7/2022 19:24:26MaleSoftware Architect55Noya know, one must ask themself:

how serious am i being taken if THREE distinct questions are asked while just ONE FIELD is provided for my answer?

wtf bruh!?
not.
vewy.
sciENCE
EEee.
r
we?		logic was never my strong suit, but i am fairly certain that i should not be able to give this answer because of Albert Einstein's 1930' Nobel Prize-winning Theory of Web Form Conditional Logic, a truly ground breaking stack of papers that his wife used to wipe up the cat's diarrhea that very night. i majored in Current Historical Hunches at university.
not braggin.
just sayin.
in case it wasn't already obvious from my previous answer, my family comes from a very very long line of accomplished hazbros and ne'er doo wells, which makes sense when you become floored by the impecibel werds n shiz.
12
6/9/2022 18:31:05Prefer not to saySoftware Engineering55YesWe struggle to write documentation for sure. We use docs as code approach including DocusaurusWe use docs as code approach including DocusaurusWe use OPENAPI for SDK and documenting APIsTBD We are open to learn and trz new stuff
13
6/10/2022 3:53:18MaleEngineering Manager/Director43YesConfluence and it isn't consistentConfluence againWe currently use Stoplight for API authoring and goverence. I need the same for events as well
14
6/10/2022 12:21:35MaleDevRel55YesAsyncAPIcode generators, mocking serverssharing
15
6/11/2022 2:54:17Prefer not to sayTechnical Writer22Nosdfsdfsfd
16
6/14/2022 2:44:41MaleSoftware Engineering35YesAsyncAPI spec covers our needsAsyncAPI specKeep documentation in sync with code
17
6/14/2022 13:06:57MaleSoftware Engineering45NoVery bad experience mostly since many tools don't support basic features of the API specification format and to get at least some documentation, you have to limit yourself in the API specification. It should be API first, but that only works with proper tooling.Concrete example in my current project using AsyncAPI for WebSocket API documentation: yaml & external refs (= splitting API docs into multiple files to RE-USE COMMON PARTS) are a 3rd class citizen. I can't believe it's so bad. Especially the AsyncAPI stuff can't handle it, and the parts that say it does, is not usuable because e.g. it duplicates all common definitions... Please have a look at OpenAPI, there it works.
18
6/15/2022 2:44:03MaleSoftware Engineering44YesAsync API is our primary interface document, with our system architecture being done in a combination of draw.io with Confluence. Our biggest challenge is storing and displaying our interface documents - what we would like to have is each code repository holding it's interface document but to be able to go to some central UI to view all of our documents.MQTT, Websockets, SignalR, EventBusOne of the things that would be beneficial to us would be a better way of referencing outside documents in async. I know references work with async, but the editor doesn't support the feature very well (because you can understandably only have one file open at once). Integrating async with 'open source' (I know technically visual studio code isn't open source!) like VSC would allow for a more powerful file structure system to be introduced.

Another would be direct integration with Git repositories, instead of having to copy and paste markup between async and a code editor to persist our documentation.
19
6/24/2022 15:53:49MaleSoftware Architect45Nolack of tools for code generation, specification validationlack of tools for code generation, specification validation
20
6/26/2022 8:02:29MaleSoftware Engineering55YesAsyncAPI documentAsyncAPI document In the repoWe share via a repo, in an AsyncAPI doc. Document things right and let developers know is the most challenging thing.
21
6/27/2022 5:17:11MaleSoftware Architect34Yesmarkdown/mermaidjsmarkdownWe use openapi for rest apisDocumentation is written after implementation. It should be generated from specification or implementation.
22
6/28/2022 10:27:17MaleAPI Design44YesMost ppl don't want to write specs. We try to fix this with a design first approachDevs look at the code or ask other devsIt's hard to know with events are provided by a system. We are trying to solve this using Backstage
23
7/4/2022 12:27:39MaleSoftware Architect55YesCurrently ad-hoc manual documentation on confluence after a discovery session that happens periodically. This doesn't work great tbh, and we are moving to async api.We share public events by sharing a library We share event contracts for use in integration through libraries. This isn't ideal and doesn't allow for independent evolution, which results in cascading changes. Libraries don't help with documentations.
24
7/8/2022 9:05:06MaleSoftware Architect54YesThere is no documentation. We have several teams, some that emit events, some that don't. Different messaging formats (that need to be standardized) for different fanout tech.It's tedious to type out JSON/YAML for documentation. Easier to do something like stoplight.io which can be form-based creation of APIs and easier to link reusable components. Repository access (git) to control changes to the API spec.Contract testing so that the docs don't fall behind what's going on in the API. Testing in both the CI/CD pipeline and in-line in the program so we know that the API in use is not out of sync with docs.
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100