10 ms·
There are some real obvious downsides to using this tool right now. Most importantly, the article lists there: * Documentation is limited, but Bun’s Discord is
by jeroenhd 4y ago
There are some real obvious downsides to using this tool right now. Most importantly, the article lists there:
* Documentation is limited, but Bun’s Discord is very active and a great source of knowledge.
I'm not interested in becoming part of a community, I want to use the tool. Without official docs, I'll pass until the project has matured.
* Bun is not 100% compatible with Node yet. Not every npm package works. Express, for instance, is not yet functional.
I don't expect full bug-for-bug Node compatibility but if extremely popular packages such as Express don't work, I'm not sure if any of my projects will even run with this runtime.
Hopefully, this project will turn into a proper Node replacement because the Javascript ecosystem can use a big performance boost. It'll be a while before it'll become part of any pipeline I have a say in, though.
- smrtinsert 4y agoThr just reinforces the power of the java community to me. Servlet container is completely a choice built around standards unlike the js community where it still seems to be node or bust. It makes java look light years ahead of js.
- chiefalchemist 4y agoTo your point, it would be refreshing - and appropriate - if more projects baked "documentation-first" into their purpose. For all intents and purposes it's "marketing materials". When it's lacking, as you noted, it creates doubt. "Join us?" Huh. Join what?!? This is one of engineering things that happens year over year. We all understand the value of good docs. Yet it keeps happening. Why?
- Waterluvian 4y agoDocs aren’t the fun part of dev.
- whynotminot 4y agoIt’s not fun to write documentation, and for documentation to be good, it has to be persistently updated. It takes a lot discipline to do things right.
- gervwyk 4y agoBecause being a small project with limited resources requires devs be as resource efficient as possible. Docs, demos, tuts are all super important but it creates an additional maintenance overhead - if they are not maintained up to date, they become worthless. So for the early stages of a project it makes sense to keep the overhead low and work with a small group of focussed early adopters. As projects grow, mature and become more stable, more investment into learning material becomes important. Doing it too early burns valuable resources.
- chiefalchemist 4y ago> As projects grow... I'd argue if should replace as. The point being docs are all but essential for growth (and added participation). To neglect them is self-defeating. Put another way: Docs are an investment. They have a known return. Again, we've seen this. We know this. Yet again and again there's case after case of docs denial.
- simonw 4y agoI've learned over time that it's much easier to incrementally update existing docs than it is to add them to a large project from scratch - so every single one of my projects, no matter how small, now has documentation from day one. As I add new features I update the docs to reflect the changes, trying to keep those documentation updates in the same commit as the tests and implementation. Since I started doing this the quality of documentation I produce has gone up a ton, because I'm constantly exercising those muscles. It's been a huge win for my coding quality and productivity too - I don't have to remember as much stuff because I can refer back to the docs, and documenting as I go along causes me to make much better design decisions. Worth noting: I'm a native English speaker writing documentation in English, and I've been blogging frequently and writing online for over twenty years so I've accumulated a LOT of writing experience. So what's easy for me may not be easy for other people!
- gervwyk 4y agoThis is good advice, thanks. Really want to practice my writing more as well.
- BaculumMeumEst 4y agobecause time is finite if you spend your time making sure your product works but don’t write thorough documentation, it can become a breakout hit even though some hacker news commenters may complain about a lack of good documentation if you spend your time writing great documentation, the product will suffer and nobody will use it
- jcpst 4y ago> if you spend your time writing great documentation, the product will suffer and nobody will use it This is an unfortunate perspective. And I could say the opposite is true. If you don’t spend time writing great documentation, your product will suffer and nobody will use it. Documentation gets neglected because developers don’t feel like doing it. If you are building a product for developers, documentation is critical.
- jamesgpearce 4y agoAgree. But it’s not either/or. I invested easily hundreds of hours in docs before launching TinyBase.org - but I don’t think it made the subsequent community building challenge any easier.
- chiefalchemist 4y agoYes, fair enough. And I'd like to add Docs !== community Docs === Odds of gaining traction To your point, achieving community is a whole other beast to battle.
- lioeters 4y agoI think it's because documentation (and design) requires different skills than writing code. A great programmer is not necessarily a good writer or designer. There are rare gems, people who have a balance of such skills, but most of us struggle to write useful documentation, even the bare minimum necessary for others to get started - or any at all. The code, or the lead dev's brain, is the documentation. A perfect example of this is documentation generated from docblock comments. Some projects only have such docs, and expect users to go from there. It's as if programmers envision their audience as another machine to program. I feel similarly about business/marketing aspects of software projects. Many programmers seem to assume, "If you write it (the program), they will come." Successful software is so much more than just the code, it usually involves a communal effort of various skills, especially human communication, including writing good documentation.
- steveklabnik 4y agoMany engineers do not value good docs, even if they say they do. Many people won’t read them at all, no matter the quality, and so it can feel like work wasted. Plus writing docs is a different skill set than writing code that many simply don’t like to do.
- thinkharderdev 4y agoThe boring (and probably mostly correct) answer is that engineers don't like writing documentation so it is the last thing to get done, if it gets done at all. This is especially true of FOSS projects. You may be motivated to spend your free time hacking on something cool and interesting, but spending your free time writing documentation is another matter.
- deleted 4y ago[deleted]
- lewisl9029 4y agoThese days now that I'm fully in charge of building my own product, I often wonder if we place too much emphasis on centralized documentation sites that users have to deliberately seek out and visit vs in-context documentation snippets that show up as closely as possible to where users might actually need them, deeply integrated into the product and user journeys. Users don't search for documentation for the sake of finding documentation. They search for documentation because they want to know how or if our product can solve a particular problem they have. My hypothesis is that the documentation discoverability problem is really just a symptom of the product discoverability problem, and that centralizing docs in 1 searchable website to make docs "discoverable" is only addressing the symptom, when that effort can be much better spent addressing the root cause by making the product itself more discoverable and deeply integrating useful documentation into it.
- deleted 4y ago[deleted]
- skybrian 4y agoI read the documentation before downloading anything, to find out if the software will work for my problem. I’m not sure that “in context” helps with that?
- spacephysics 4y agoThat’s what kaseya is doing with their software, basically having contextual assistance for each feature as an “AI Buddy”, where users can choose to listen/learn or just continue using the product, all integrated as one
- replygirl 4y ago> centralizing docs in 1 searchable website to make docs "discoverable" is only addressing the symptom a searchable docs website is the most important thing for me. having to "discover" an api by stepping through code and comments is a waste of time--only useful when you already know the basics, which requires documentation
- vlovich123 4y agoCentralized documentation is valuable for several pieces: * Easily get an overview of the entire API. I may just be scouting the library, so I want to understand what the API looks like. * Examples as a starting point. How do I use your API? * Makes your product more discoverable / approachable to potential users. Think of your users like a funnel - how are they using the library? What are the common reasons you’re losing potential users? What are the common reasons you’re losing existing users? Users are also different so you have to analyze by cohort. Now can something better be done? Maybe It takes a lot of work and would have to address the above issues and I don’t know if it would necessarily change the need for something centralized.
- lelanthran 4y ago> This is one of engineering things that happens year over year. We all understand the value of good docs. Yet it keeps happening. Why? Because doing anything is is irrational? Time is finite, only a rounding error number of projects (especially open-source ones) are going to be successful, with or without docs. Only an irrational developer would think that they are going to hit the 1-in-a-thousand jackpot with their project. Any time spent producing documentation is time not spent on adding features and fixing bugs. Spending time on documentation over and above the bare necessity needed to get out a working product "just in case we win the jackpot" is simply irrational. This is probably why you don't find many projects spending significant startup time on good, clear and comprehensive docs (as opposed to a README and an FAQ and nothing more): the ones that do as you suggest mostly die before even getting users. TLDR; don't treat your startup project as if you already have 5m users who depend on you. The odds are that you are never going to get to that point without a good product, and the better the product, the fewer the docs needed.
- rswail 4y agoBecause people are "scratching an itch", not creating a product. Most engineers are terrible at writing documentation.
- chiefalchemist 4y agoTrue. Adding tho' that the original topic isn't a side project. It's a team bringing something to market and looking for participants. And to your point, writing docs *is* something to consider when building the team. As is making sure the culture has a reward system if such behavior is important.
- yen223 4y agoBecause a poorly-documented product that does something, is much better than a well-documented product that does nothing. Engineers have to decide where to spend their time, and taking time away from feature development when your early-stage product doesn't have many features is not a winning move.
- replygirl 4y ago> a poorly-documented product that does something, is much better than a well-documented product that does nothing not necessarily. with the latter, you know the constraints of a solution and can make an accurate judgment on whether it's worth using
- wruza 4y agoTrue, but if it’s too early for a good documentation then talking about taking someone’s crown is too early as well.
- r_hoods_ghost 4y agoYep, doing documentation and support through a chat service designed for gamers with terrible search that means the same question is going to be asked over and over again and where most users behave as if they were 15 year olds because that is the prevailing social norm means I'm going to pass.
- acedTrex 4y agoDiscords text search is incredible though, It's still not a good platform for support but not because search is bad
- andybak 4y ago> Discord's text search is incredible Really? There's no way to do verbatim searches and it's "very" generous in deciding what it thinks you meant to search for. It's almost useless for searching technical posts (or anything when you need to disambiguate similar words)
- MatthiasPortzel 4y agoThe primary use case that we’re talking about is that someone has a common error, in which case they can put that error message into Discord search and read conversation about previous errors. Discord search is perfectly adequate for that use case.
- antifa 4y agoThe primary use case is actually googling the error, in which discord falls flat on it's face. Every external chat room logs service I've seen has also had bad SEO, buggy, bad UI/UX, etc..
- andybak 4y agoThat's fairly close to my use case for which Discord fails miserably. But let's not get stuck on this point. There's a dozen other reasons why Discord shouldn't be used for technical forums
- Bolkan 4y agoAnd it doesn't address the semver malware injection bug demonstrated by colors author. Funny isn't it, any one of the thousands of npm package authors can inject a malware into our computers and nobody gives a shit. https://snyk.io/blog/open-source-npm-packages-colors-faker/ https://snyk.io/blog/open-source-npm-packages-colors-faker/
- Supermancho 4y ago> And it doesn't address the semver malware injection bug demonstrated by colors author [Not a fan of Bun] In Bun, you can pin versions with package.json just like in node.js What would address the malware injection when someone chooses to auto-update packages as part of a build?
- Bolkan 4y agoYou can only pin your direct deps.
- leodriesch 4y agoA lockfile is a way to lock your indirect dependencies. If you only install based on the lockfile every dependency is pinned.
- Bolkan 4y agoYou cannot audit and pin all your transitive dependencies. The amount of churn tge lockfile goes through is insane.
- deleted 4y ago[deleted]
- WorldMaker 4y agoDependabot watches all the transitive dependencies in your lock files. For better and worse. For worse in that it's not a great developer experience to get a PR on a low level transitive dependencies, which is also one of the largest complaints about Dependabot that it often feels too low level and not working at the dependency level you are working at. But Dependabot (and npm audit) still exist to audit all your low level transitive dependencies in your lock files.
- sbmthakur 4y ago> Documentation is limited, but Bun’s Discord is very active and a great source of knowledge. What sort of knowledge are we talking about?
- toastal 4y agoThe kind that requires another proprietary account behind a nonfree service to get access to.
- hn_throwaway_99 4y agoIn one sense, I completely agree with your central point: Bun isn't yet stable enough or mature enough for production, "Node drop in" usage. But on the other hand, when I look at Bun I think it has heaps more going for it than Deno. The fundamental value prop of offering better performance (both runtime and developer experience) is huge, and something that would get me to want to use it. Contrarily, while I see a number of improvements in Deno, the vast majority of them seem to be "niceties" that solve some initial "setup" issues that can be painful in Node - but since I already have taken care of a lot of those Node issues in my own projects, there is not a ton that I see compelling in Deno. Point being, if I were a betting man, I'd easily put all my chips on Bun vs. Deno. It's a "plan where the puck is headed" vs. a "plan where the puck is now" approach, and from that perspective I see a lot more value in Bun.
- modernerd 4y ago> …I already have taken care of a lot of those Node issues in my own projects, there is not a ton that I see compelling in Deno. I felt this way too before using Deno for a while. So far I enjoy: - Breaking from npm/node modules support on purpose turns out to be a real plus for me. It's refreshing to have dependencies referenced by URL, and it's good to have them cached centrally by default (in $HOME/Library/Caches/deno on macOS and $XDG_CACHE_HOME/deno or $HOME/.cache/deno on Linux, for example). - Use of web platform APIs (https://deno.land/manual/runtime/web_platform_apis https://deno.land/manual/runtime/web_platform_apis ) and the work to standardise those across platforms (https://wintercg.org/ https://wintercg.org/ ) is encouraging. - `deno lint` and `deno fmt` make adopting and using JS/TS feel more like Rust/Go/other languages with good built-in ceremony-free tooling. - Fresh is turning into a very nice Next.js/Astro alternative (https://fresh.deno.dev/ https://fresh.deno.dev/ ) that I found very easy to learn and deploy, with great performance and developer experience out of the box. Bun is interesting, but I wish it didn't embrace node modules: perpetuating its use instead of attempting to move the community on by recognising it for the mistake it was feels sad to me. (See Ryan Dahl's “Design Mistakes in Node” PDF or talk for more: https://tinyclouds.org/jsconf2018.pdf https://tinyclouds.org/jsconf2018.pdf and https://www.youtube.com/watch?v=M3BM9TB-8yA https://www.youtube.com/watch?v=M3BM9TB-8yA )
- yashap 4y agoIt’s a work in progress, it’s definitely not meant to be ready for production workloads yet. It’s in beta, I’m assuming if they do get to a full stable release, node compatibility will be far better, Express will work, official docs will be improved, etc.
- thayne 4y agoAnother concern I have is that cool as zig is, it is still pretty unstable, with breaking changes almost every release. So, I'm not sure i would want to trust this with production code.
- highwaylights 4y agoTrue story: “But our Discord is very active“ is the new “hard pass”. Tell your friends. We’re gonna make fetch happen.
- mulmen 4y agoDiscord scares the crap out of me. I just don’t trust the app. I couldn’t figure out how to stop it from opening on boot. And it has access to my camera and mic for some reason? Managing identities across different communities seems leaky at best because I think I have to change my name after joining. I’m sure a lot of this is my own ignorance of the tool but I have no interest in learning a modern gamer chat service. None of it is going to stay the same in 10 years, or even 10 weeks. That’s all a hard pass. This says nothing of what a terrible choice it is for a knowledge base, especially long term. The only way you choose Discord is if you aren’t thinking beyond the “next release”. That’s a huge red flag in a fundamental framework project like this.
- kayodelycaon 4y agoChanging your nickname on a server doesn’t hide the name used on your account from anyone. This is why I’m not on my work’s discord server.
- kaetemi 4y agoYou can have multiple accounts in the Discord client now.
- mulmen 4y agoSure. For now. But I have to carefully police the features of every release before I start the application. It’s a minefield. People will get hurt. Those of us who have been around will be entitled to say we told you so. But I hope users move away before they get hurt, which will happen. This is a proprietary application and protocol. It will come back and hurt you. Get out while you can.
- userbinator 4y agoAnd it has access to my camera and mic for some reason? That's not unexpected given that it has voice and video chat functionality. if you aren’t thinking beyond the “next release”. I think that lack of long-term thinking is endemic to the JS community in general, unfortunately.