<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Szymon Rusiecki on Medium]]></title>
        <description><![CDATA[Stories by Szymon Rusiecki on Medium]]></description>
        <link>https://medium.com/@szymeker?source=rss-12d75e69ee72------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*F1lObaRsEJpPicPCYQ8fYw.jpeg</url>
            <title>Stories by Szymon Rusiecki on Medium</title>
            <link>https://medium.com/@szymeker?source=rss-12d75e69ee72------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Thu, 19 Nov 2026 05:15:42 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@szymeker/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Unlocking Data Platform Success: The Power of Documentation]]></title>
            <link>https://medium.com/@szymeker/unlocking-data-platform-success-the-power-of-documentation-2b7bcf710f54?source=rss-12d75e69ee72------2</link>
            <guid isPermaLink="false">https://medium.com/p/2b7bcf710f54</guid>
            <category><![CDATA[data-engineering]]></category>
            <category><![CDATA[data-platforms]]></category>
            <category><![CDATA[software-development]]></category>
            <category><![CDATA[software-engineering]]></category>
            <dc:creator><![CDATA[Szymon Rusiecki]]></dc:creator>
            <pubDate>Mon, 08 Jan 2024 10:06:27 GMT</pubDate>
            <atom:updated>2024-01-08T10:11:52.831Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*YvueWVw62NeKKQlV54EH7A.jpeg" /><figcaption>The Power of Documentation</figcaption></figure><p>Documentation is not always the top priority when building a data platform. This may seem like an easy choice when resources are limited. However, it can limit the usability of the platform and have a direct impact on user experience. Let’s explore why up-to-date documentation is crucial.</p><h3>Being a platform</h3><p>A platform connects multiple technologies and simplifies using them. Typically, there is some form of abstraction, such as code, configuration files, or UI. It is not optimal to guess how to configure components. Moreover, making users to dive into the orchestration code to understand its functioning is also far from ideal. Good documentation should guide users through design, architecture decisions, capabilities, and limitations.</p><h3>Reducing on-call burden</h3><p>In many cases, the on-call person for the data platform is designated as the first tier of support for tenants. However, this approach does not scale well and can lead to prolonged response times, missed messages, and user complaints. Introducing high-quality documentation and providing a frequently asked questions page can significantly reduce this on-call burden. Users can find solutions to common issues without having to rely on direct support, resulting in a more efficient and responsive system.</p><h3>Providing release notes</h3><p>Release notes play a vital role in keeping users informed about updates and changes to the data platform. Placing release notes alongside documentation creates a coherent experience for users. All changes should be clearly described, and instructions for applying them should be easily accessible. Any dependencies between different versions of components should also be noted, ensuring users can effortlessly move between versions without unexpected issues.</p><h3>Placing the documentation close to the users</h3><p>Ideally, adopting a versioned system for documentation proves to be the most effective strategy. This approach enables the application of well-established best practices derived from software development, such as conducting Pull Request reviews. Additionally, take into consideration the data-sync with the most commonly used platforms, like Confluence, internal Wiki, or Stack Overflow for Teams. Integrating version control into the documentation process and leveraging automated pipelines ensures seamless collaboration and continuous improvement. This dynamic environment aligns with evolving user needs and platform changes, providing users with a comprehensive and unified resource.</p><h3>Improvement through user feedback</h3><p>User feedback is a valuable asset in the evolution of a data platform. Establishing a user-friendly feedback loop allows users to share their experiences, report any ambiguities, or suggest improvements. Regular monitoring and incorporating user feedback ensures that the documentation remains not only up-to-date, but also aligned with the evolving needs and expectations of the user community.</p><h3>Enforcing security</h3><p>In the dynamic landscape of data platforms, security and compliance are paramount. An up-to-date documentation system should include detailed guidelines on security best practices, data protection measures, and compliance requirements. Providing comprehensive documentation on these critical aspects not only instills confidence in users, but also helps them effectively navigate potential regulatory challenges.</p><h3>Building trust</h3><p>As most features are documented, tenants begin to build trust in the platform. Trust is a key factor in the success of any technology platform. When users can easily find accurate information and understand how it operates, they are more likely to rely on it for their data processing needs.</p><h3>Using AI</h3><p>To enhance user accessibility, consider incorporating AI-driven features into the documentation. AI can assist in providing context-aware help and suggesting relevant components based on user queries.</p><h3>Conclusion</h3><p>In conclusion, up-to-date documentation is an essential component of a successful data platform. It enhances usability, reduces support burdens, keeps users informed about changes, builds trust, and can be further improved with the integration of AI-driven features.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=2b7bcf710f54" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>